This wiki has undergone a migration to Confluence found Here
Difference between revisions of "Analysis Information Model Artifact Definition"
Jump to navigation
Jump to search
(Created page with "{{subst::Template:SAIF Artifact Definition}}") |
|||
Line 1: | Line 1: | ||
+ | [[Category:SAIF Artifact Definition]] | ||
=Some Artifact Name= | =Some Artifact Name= | ||
− | |||
− | <!-- | + | <!-- Artifact names should be descriptive and short. They may change as we further refine the methodology --> |
+ | |||
+ | == Definition and Purpose == | ||
+ | |||
+ | <!-- At a high level, what is this artifact and why is it needed? Should ideally be only a few sentences --> | ||
+ | |||
+ | Put text here | ||
+ | |||
+ | == SAIF Matrix Location == | ||
+ | |||
+ | <!-- Where does this artifact fit into the SAIF matrix? Delete those rows and columns that do not apply and provide qualification if appropriate --> | ||
+ | '''Row(s)''' | ||
+ | * Conceptual (CIM) | ||
+ | * Logical (PIM) | ||
+ | * Implementable (PSM) | ||
+ | |||
+ | '''Column(s)''' | ||
+ | * Enterprise/Business | ||
+ | * Information | ||
+ | * Computational | ||
+ | * Engineering | ||
+ | |||
+ | == Audience == | ||
+ | |||
+ | <!-- Who will be the consumers of this artifact type and what will they do with it? --> | ||
+ | Text | ||
+ | |||
+ | == Applicablity == | ||
+ | |||
+ | <!-- Under what circumstances does this artifact type need to be created? Are there circumstances where this artifact should not exist? Why? --> | ||
+ | Text | ||
+ | |||
+ | <i>Rationale</i>: More text | ||
+ | |||
+ | == Requirements == | ||
+ | |||
+ | <!-- What are the needs that this particular artifact was created to satisfy and why are those needs important. --> | ||
+ | # Some requirement | ||
+ | ## <i>Rationale</i>Some reason | ||
+ | |||
+ | # Some other requirement | ||
+ | ## <i>Rationale</i>Some other reason | ||
+ | |||
+ | == Relationships and traceability == | ||
+ | |||
+ | <!-- What are the other artifacts that are related to this artifact? How? Why is the relationship important? --> | ||
+ | * Some relationship | ||
+ | ** <i>Rationale</i>: Reason for relationship | ||
+ | |||
+ | * Some other relationship | ||
+ | ** <i>Rationale</i>: Reason for other relationship | ||
+ | |||
+ | == Artifact Technology == | ||
+ | |||
+ | <!-- What technological/standard solution has been selected for use in creating this artifact and why? --> | ||
+ | Text here | ||
+ | |||
+ | === Rationale === | ||
+ | * Some reason | ||
+ | * Some other reason | ||
+ | |||
+ | === Alternatives === | ||
+ | |||
+ | <!-- What other technical solutions might have been possible that were discarded, what did they offer and why were they not chosen? --> | ||
+ | |||
+ | <b>Some technology</b> | ||
+ | * Some pro or con | ||
+ | * Some other pro or con | ||
+ | |||
+ | == Content Constraints == | ||
+ | |||
+ | <!-- What are the formal rules about how the artifact can be constructed, including any extensions and constraints as well as the rationale for those rules. These are rules that can reasonably be enforced or validated by tools. --> | ||
+ | # Some rule | ||
+ | ## <i>Rationale</i>: Some reason | ||
+ | |||
+ | # Some other rule | ||
+ | ## <i>Rationale</i>: Some other reason | ||
+ | |||
+ | == Content Guidelines == | ||
+ | |||
+ | <!-- What are the informal guidelines about how the artifact content. I.e. What constitutes good practice? These guidelines should be used in the evaluation of artifact instances but generally can't be enforced or validated by tools. --> | ||
+ | # Some rule | ||
+ | ## <i>Rationale</i>: Some reason | ||
+ | |||
+ | # Some other rule | ||
+ | ## <i>Rationale</i>: Some other reason | ||
+ | |||
+ | == Publishing Constraints == | ||
+ | |||
+ | <!-- How will this artifact be shared and published as part of specifications and what are the reasons behind such constraints? --> | ||
+ | # Some rule | ||
+ | ## <i>Rationale</i>: Some reason | ||
+ | |||
+ | # Some other rule | ||
+ | ## <i>Rationale</i>: Some other reason | ||
+ | |||
+ | == Tooling Considerations == | ||
+ | |||
+ | <!-- What tooling features are required or "nice to have" to allow successful development, publication or other use of the artifact? --> | ||
+ | # Nice-to-have|Required: Some feature | ||
+ | ## <i>Rationale</i>: Some rationale | ||
+ | |||
+ | # Nice-to-have|Required: Some other feature | ||
+ | ## <i>Rationale</i>: Some other rationale |
Revision as of 09:28, 11 January 2011
Contents
Some Artifact Name
Definition and Purpose
Put text here
SAIF Matrix Location
Row(s)
- Conceptual (CIM)
- Logical (PIM)
- Implementable (PSM)
Column(s)
- Enterprise/Business
- Information
- Computational
- Engineering
Audience
Text
Applicablity
Text
Rationale: More text
Requirements
- Some requirement
- RationaleSome reason
- Some other requirement
- RationaleSome other reason
Relationships and traceability
- Some relationship
- Rationale: Reason for relationship
- Some other relationship
- Rationale: Reason for other relationship
Artifact Technology
Text here
Rationale
- Some reason
- Some other reason
Alternatives
Some technology
- Some pro or con
- Some other pro or con
Content Constraints
- Some rule
- Rationale: Some reason
- Some other rule
- Rationale: Some other reason
Content Guidelines
- Some rule
- Rationale: Some reason
- Some other rule
- Rationale: Some other reason
Publishing Constraints
- Some rule
- Rationale: Some reason
- Some other rule
- Rationale: Some other reason
Tooling Considerations
- Nice-to-have|Required: Some feature
- Rationale: Some rationale
- Nice-to-have|Required: Some other feature
- Rationale: Some other rationale