|
Size: 1192
Comment:
|
← Revision 13 as of 2010-03-17 13:12:29 ⇥
Size: 1572
Comment: converted to 1.6 markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| A collection description is the formalization combined with the Pattern Expression, that documents the used patterns and the rationalizations upon which the collection is based. | = Collection Name = The purpose of the collection document is two-fold it is a documentation of the |
| Line 3: | Line 4: |
| So the abstraction layers are: | In general use references to patterns and other collections to allow new collection authors to be "standing on the shoulders of giants"~-[[http://en.wikipedia.org/wiki/Bernard_of_Chartres|[quote]]]-~. |
| Line 5: | Line 6: |
| *'''Pattern expression''' -- The general, and yet formalized, description of the process and thoughts that forms the basis of the collection architecture. with references to a series of connected patterns. *'''Collection description''' -- A short, more technical, description of the elements that form the collection. *'''Technical/Collection formalization''' -- The actual DOMS collection described. This should be represented in the best possible way, it can be a diagram, it can also be represented by a XML file, or parts thereof. Other descriptive measures should also be considered. |
=== Is part of collection === |
| Line 9: | Line 8: |
| = Pattern expression = Write your pattern expression here |
Default is: |
| Line 12: | Line 10: |
| = Collection description = Sum up the elements in the collection here |
isPartOfCollection doms:Root_Collection |
| Line 15: | Line 12: |
| = Technical = | === Contains, sub collections and objects === This can be whatever is contained within. == Pattern expression == Write your pattern expression here, it's the rationale behind the collections structure. Let the expression be your dreams, ideas and thoughts for the collection. == Collection description == Sum up the elements in the collection here, if you feel that you need to justify parts of your collection, and have asserted that your plan is sound. Include the rationale here, if possible back it up with new patterns describing your special collection. == Workflow == This is the manual, if you want people to [[http://en.wikipedia.org/wiki/RTFM|RTFM]] make a [[http://en.wikipedia.org/wiki/Technical_writing#Example|FM]] Describe the intended usage of and content addition to this collection, use all available measures that help clarify on the subject. Consider images in addition to text. == Technical == |
| Line 18: | Line 33: |
| Consider using a drawing to illustrate relations or for instance include code/XML snippets | Consider using a drawing to illustrate relations or for instance include code/XML snippets. |
Collection Name
The purpose of the collection document is two-fold it is a documentation of the
In general use references to patterns and other collections to allow new collection authors to be "standing on the shoulders of giants"[quote].
Is part of collection
Default is:
isPartOfCollection doms:Root_Collection
Contains, sub collections and objects
This can be whatever is contained within.
Pattern expression
Write your pattern expression here, it's the rationale behind the collections structure.
Let the expression be your dreams, ideas and thoughts for the collection.
Collection description
Sum up the elements in the collection here, if you feel that you need to justify parts of your collection, and have asserted that your plan is sound. Include the rationale here, if possible back it up with new patterns describing your special collection.
Workflow
This is the manual, if you want people to RTFM make a FM
Describe the intended usage of and content addition to this collection, use all available measures that help clarify on the subject. Consider images in addition to text.
Technical
Be concrete and go into detail of things that require it, especially parts of the collection that is complex or of a special nature.
Consider using a drawing to illustrate relations or for instance include code/XML snippets.