CT2 Wiki

From UG

Revision as of 23:03, 20 January 2010 (edit) Alex (Talk | contribs) ← Older edit

Revision as of 17:28, 22 January 2010 (edit) (undo) Alex (Talk | contribs) m (moved CT2 Wiki to About CT2 Wiki) Newer edit →

---

Revision as of 17:28, 22 January 2010

Contents 1 Intro 2 CT2 wiki standards 2.1 Creating a new article 2.2 Standard sections 2.2.1 use cases 2.3 Creating a new version of the spec 2.4 Standard Section for spec

Intro

CT2 Wiki (homepage address: http://mantis.jaguarfreight.com/wiki/Main_Page) is web based knowledgebase for CT2 Software Development Project.

It is based on wiki platform.

It is used for:

• documenting CT2 requirements and systems specifications (specs)
• project management articles
• other related knowledge useful for CT2 Team

CT2 wiki standards

Creating a new article

• Pick the right name. Ideally article name should consist of several words separated by spaces.
• Link it to category. There is a category tree that starts [Category:CT2]

Standard sections

== Business Needs and Requirements ==
== Specs ==
== Use cases ==
== QA ==
== Look And Feel ==
== RFC ==
== Tweaks == 
== Dev ==

use cases

• Use cases describe the system from the user's point of view.
• Each use case focuses on describing how to achieve ONE particular goal or task
• Describes step by step what user does and how system responds

• see also http://en.wikipedia.org/wiki/Use_cases

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"

Standard Section for spec

TBD