What Is And How To Write CT2 Spec

From UG

Revision as of 15:56, 23 January 2010 (edit) Alex (Talk | contribs) (→How To Write It) ← Older edit		Revision as of 16:29, 25 January 2010 (edit) (undo) Alex (Talk | contribs) Newer edit →
Line 1:		Line 1:
-	[[Category: SA Misc]]	+	[[Category:Documentation]]
	== What Is It ==		== What Is It ==

---

Revision as of 16:29, 25 January 2010

Contents 1 What Is It 2 How To Write It 2.1 Creating a new article 3 See also 4 RFC 4.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.

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"