What Is And How To Write CT2 Spec

(Difference between revisions)

Revision as of 08:26, 2 February 2010

CT2 Spec is a "portal" for specific CT2 component that contains documented requirements/design/etc. It is a part of CT2 Wiki.

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.

Also use "summary" field and "This is a minor edit" checkbox.

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

Examples of "well written" (but not ideal!) CT2 spec:

Pick the right name. See #Article name conventions
Link it to wiki category. There is a category tree that starts with Category:CT2

This section contains not yet approved ideas.

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"

@@ Line 16: / Line 16: @@
 If you save after every little change then it would be harder to see how many times it was changed and for what reason.
+Also use "summary" field and "This is a minor edit" checkbox.
 == Top Down Approach, Correct Workflow, Collaboration ==