What Is And How To Write CT2 Spec
From UG
(Difference between revisions)
| Line 3: | Line 3: | ||
== What Is It == | == What Is It == | ||
| - | CT2 Spec is a "portal" for specific [[CT2 component]] that contains documented requirements/design/etc. | + | CT2 Spec is a "portal" for specific [[CT2 component]] that contains documented requirements/design/etc. It is a part of [[CT2 Wiki]]. |
== How To Write It == | == How To Write It == | ||
Revision as of 17:54, 22 January 2010
Contents |
What Is It
CT2 Spec is a "portal" for specific CT2 component that contains documented requirements/design/etc. It is a part of CT2 Wiki.
How To Write It
- see Generic Spec Template
- see Wiki Template for Ops Admin
- see Wiki Template for Ops Pdfs
- see Wiki Template for Ops Reports
Examples of "well written" (but not ideal!) CT2 spec:
- In Transit Report
- ....
Creating a new article
- Pick the right name. See #Article name conventions
- Link it to wiki category. There is a category tree that starts with Category:CT2
See also
RFC
This section contains not yet approved ideas.
Creating a new version of the spec
- Assume that article name is: Aaaa Bbbbbb Ccc
- If you believe that old version should be preserved then:
- Create new article named: "Aaaa Bbbbbb Ccc v2"
- In article "Aaaa Bbbbbb Ccc":
- set background "olive"
- add "orange" link to "Aaaa Bbbbbb Ccc v2"
