wiki:PLATFORM_STANDARDS_GENERAL

Version 3 (modified by deyan, 17 years ago) (diff)

--

Tasks results

Each task should have a wiki page which should contain one or more of the following result types:

Result Types

  • Specification (produced in the analysis phase of each task) or link to specification in following format:

!==Specification==
[wiki:PAGE]

  • a link to development document (produced in the design phase). Can also be the final result of a task. This should be in following format:

!==Development Document== [source:/path/filename] path here should be changed when format of development documents is chosen

  • a diagram (usually as a part of a specification or development document).
    • Diagrams should be stored in the repository, at their proper place.
      • trunk\sophie2-platform\doc\spec-diagrams
      • trunk\sophie2-platform\doc\dev-doc-diagrams
    • Each diagram should be exported to PNG format with the same name as it's original format. Original format should be kept so the diagram can be edited later.
    • Diagrams should be included in the wiki page by inserting
      • [[Image(source:/trunk/sophie2-platform/doc/spec-diagrams/image.png)]] for specification diagrams
      • [[Image(source:/trunk/sophie2-platform/doc/dev-doc-diagrams/image.png)]] for dev-doc diagrams.

" [source:filename]" (Preview:filename) [Image:filename] [source:filename]

# a how-to (usually as a part of a development document)

  • Source code (produced in the implement phase of most tasks). Files should be linked by [source:/path/filename]

# a review (done after each phase). This decides whether the task can proceed to the next phase.