What Is And How To Write CT2 Spec

From UG

(Difference between revisions)
Jump to: navigation, search
(→See also)
(→How to write a good spec)
 
(One intermediate revision not shown)
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]].
 +
 +
== How to write a good spec ==
 +
 +
=== Three C of good spec ===
 +
 +
For spec to be good it must be:
 +
 +
* '''Clear'''
 +
* '''Correct'''
 +
* '''Complete'''
 +
 +
=== SpecQA ===
 +
 +
'''SpecQA''' is a process of reviewing spec and reporting problems with spec.
 +
 +
See good example of SpecQAReport in http://mantis.jaguarfreight.com/mantis/view.php?id=2102
== Optimal Use of History and Preview Features ==
== Optimal Use of History and Preview Features ==

Current revision as of 23:48, 6 June 2010


Contents

[edit] 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.

[edit] How to write a good spec

[edit] Three C of good spec

For spec to be good it must be:

  • Clear
  • Correct
  • Complete

[edit] SpecQA

SpecQA is a process of reviewing spec and reporting problems with spec.

See good example of SpecQAReport in http://mantis.jaguarfreight.com/mantis/view.php?id=2102

[edit] 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.

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

[edit] 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

[edit] How To Write It

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

[edit] Creating a new article

[edit] See also

[edit] RFC

This section contains not yet approved ideas.

[edit] 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"
Retrieved from "https://wiki.jaguarfreight.com/What_Is_And_How_To_Write_CT2_Spec"
Personal tools