What Is And How To Write CT2 Spec
From UG
(Difference between revisions)
(→What Is It) |
(→What Is It) |
||
| Line 4: | Line 4: | ||
CT2 Spec is a "portal" for specific [[CT2 component]] that contains documented requirements/design/etc. It is a part of [[CT2 Wiki]]. | CT2 Spec is a "portal" for specific [[CT2 component]] that contains documented requirements/design/etc. It is a part of [[CT2 Wiki]]. | ||
| + | |||
| + | == Optimal Use of History and Preview Features == | ||
| + | |||
| + | Every wiki has a "history" - log of changes. | ||
| + | |||
| + | If you have particular task then commit final version ("Save page" button) it only after you finished. | ||
| + | |||
| + | Until then if you need to edit+preview+edit+preview then use "Show preview" button. | ||
| + | |||
| + | In this case History will have meaningful list of items and it is easy to use "diff". | ||
| + | |||
| + | If you save after every little change then it would be harder to see how many times it was changed and for what reason. | ||
== Top Down Approach, Correct Workflow, Collaboration == | == Top Down Approach, Correct Workflow, Collaboration == | ||
Revision as of 22:26, 30 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.
Optimal Use of History and Preview Features
Every wiki has a "history" - log of changes.
If you have particular task then commit final version ("Save page" button) it only after you finished.
Until then if you need to edit+preview+edit+preview then use "Show preview" button.
In this case History will have meaningful list of items and it is easy to use "diff".
If you save after every little change then it would be harder to see how many times it was changed and for what reason.
Top Down Approach, Correct Workflow, Collaboration
It is important to understand that wiki spec for component is one article but:
- multiple team members contribute to it
- there is a correct "flow": for example Business Requirements section must be written before Detailed Design section and if BR section is updated again then Detailed Design must be updated accordingly
How To Write It
- see Generic Spec Template (important!)
- 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:
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"
