|
Size: 653
Comment:
|
Size: 1381
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
| 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"~-[http://en.wikipedia.org/wiki/Bernard_of_Chartres [quote]]-~. |
|
| Line 4: | Line 7: |
| Write your pattern expression here, it's the rationale behind the collections structure. | 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. |
| Line 7: | Line 13: |
| Sum up the elements in the collection here | 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. |
| Line 10: | Line 16: |
| 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] |
|
| Line 15: | Line 23: |
| 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"[http://en.wikipedia.org/wiki/Bernard_of_Chartres [quote]].
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
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.