What Is And How To Write CT2 Spec

From UG

Contents 1 What Is It 2 Top Down Approach, Correct Workflow, Collaboration 3 How To Write It 3.1 Creating a new article 4 See also 5 RFC 5.1 Creating a new version of the spec

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.

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:

• Airlines
• In Transit Report
• Delivery Order Trucking Air

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

• About Software Requirements In General
• Use Case
• Wiki Editing Tips And Tools

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"