Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0
OOPM:Templates:Documentation:Development:IterationStatement:1.0
About This Template
This is an initial draft of the IterationStatement template version 1.0
TODO
adjust existing other template sections to adhere to the standards set forth in section #References
Test Cases
OOPM:Templates:Documentation:Development:IterationStatement:1.0:Testcase
Meta
Template Name | Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0 |
Author | Carsten Klein "rts" <carsten.klein@abstraxion.de> |
Created | 2009-04-07 |
Edited | 2009-{{#if: 04 < 10 | 004 | 04 }}-08 |
Purpose
TBD Template purpose
Synopsis
{{#ifeq: Templates:OOPM:Templates:Documentation:Development:IterationStatement:1.0 |iteration=<Integral> // the iteration number |release=<ReleaseVersion>> // the release version targetted by the iteration |goals=<WikiMarkup> // standard wiki markup formulating the goals for this iteration |produces=<WikiMarkup> // standard wiki markup stating the expected produces of the iteration |subprojects=<WikiMarkup> // standard wiki markup stating the affected/active subprojects for this iteration |references=<WikiMarkup> // standard wiki markup providing references to internal a/o external resources | none | no synopsis available |{{Templates:OOPM:Templates:Documentation:Development:IterationStatement:1.0 |iteration=<Integral> // the iteration number |release=<ReleaseVersion>> // the release version targetted by the iteration |goals=<WikiMarkup> // standard wiki markup formulating the goals for this iteration |produces=<WikiMarkup> // standard wiki markup stating the expected produces of the iteration |subprojects=<WikiMarkup> // standard wiki markup stating the affected/active subprojects for this iteration |references=<WikiMarkup> // standard wiki markup providing references to internal a/o external resources
}} }}
Parameter Reference
goals
unordered list of goals where individual entries are categorized by Documentation, Learning, etc. additional sub categories such as Documentation::Process, or Development::Process, or Documentation::HowTo can be defined and must be documented in the wiki, the categories are named based on the types of produces being produced by the iteration
Example
Preview
IMPORTANT: Please do not create the below linked to dummy pages.
TBD preview for goals section
produces
unordered list of produces where individual entries are categorized by Wiki, Repository and IssueTracker additional categories can be added as required, however, they must be documented in the wiki the categories are named based on the storage being used for the individual produces of the iteration
Example
|produces= * Wiki ** [[WikiProduce1]] ** [[WikiProduce2]] * Repository ** [[RepositoryProduce1]] ** [[RepositoryProduce2]] * IssueTracker ** https://.../IssueTrackerProduce1 ** https://.../IssueTrackerProduce2
Preview
IMPORTANT: Please do not create the below linked to dummy pages.
- Wiki
- Repository
- IssueTracker
subprojects
displays a tree of subprojects affected the iteration using an unordered list
individual items can be laid out as links to individual sub project pages in the
wiki, if available a/o desired
Example
|subprojects= * [[Requirements Analysis]] * [[Prototype Development]] ** [[Architecture and Design]] ** [[Prototype Implementation]] ** [[Prototype Maintenance]]
Preview
IMPORTANT: Please do not create the below linked to dummy pages.
- Requirements Analysis
- Prototype Development
references
provides an unordered list of references to either internal a/o external documents and other resources
individual items may be categorized by reference categories, where individual categories must be named
by the content type of the resource referenced, e.g. Media, Files, Documents and so on
Example
|references= * Documents ** [http://foo/bar.html document describing a bar] * Media ** [https://foo/bar_visiting.mov movie on bar visiting] * Files ** [http://foo/bar_draining.java sample source implementing a bar draining algorithm]
Preview
IMPORTANT: Please do not create the below linked to dummy pages.
- Documents
- Media
- Files
{{#ifeq: TBD include testcase for preview | none | |
Preview
IMPORTANT NOTICE: Do not edit a/o create the below dummy links.
TBD include testcase for preview }}
Uses Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader