Difference between revisions of "Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0"

From Apache OpenOffice Wiki
Jump to: navigation, search
(→‎Iteration Statement)
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
−
OOPM:Templates:Documentation:Development:IterationStatement:1.0
+
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader
−
 
+
−
== 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]]
+
−
</noinclude>
+
−
 
+
−
<noinclude>
+
−
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0
+
 
|author=Carsten Klein "rts" <carsten.klein@abstraxion.de>
 
|author=Carsten Klein "rts" <carsten.klein@abstraxion.de>
 
|created=2009-04-07
 
|created=2009-04-07
Line 20: Line 6:
 
TBD Template purpose
 
TBD Template purpose
 
|synopsis=
 
|synopsis=
−
  Templates:OOPM:Templates:Documentation:Development:IterationStatement:1.0
+
  Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0
−
  &#124;iteration=<Integral> // the iteration number
+
&#124;issue=<HyperLink>
−
  &#124;release=<ReleaseVersion>> // the release version targetted by the iteration
+
  &#124;iteration=<Integral>
−
  &#124;goals=<WikiMarkup> // standard wiki markup formulating the goals for this iteration
+
  &#124;release=<ReleaseVersion>>
−
  &#124;produces=<WikiMarkup> // standard wiki markup stating the expected produces of the iteration
+
  &#124;features=<WikiMarkup>
−
  &#124;subprojects=<WikiMarkup> // standard wiki markup stating the affected/active subprojects for this iteration
+
  &#124;produces=<WikiMarkup>
−
  &#124;references=<WikiMarkup> // standard wiki markup providing references to internal a/o external resources
+
  &#124;subprojects=<WikiMarkup>
 +
  &#124;references=<WikiMarkup>
 
|parameters=
 
|parameters=
−
'''goals'''
+
* issue
−
 
+
: Hyperlink to the associated issue in the issue tracker.
−
unordered list of goals where individual entries are categorized by Documentation, Learning, etc.
+
* iteration
−
additional sub categories such as Documentation::Process, or Development::Process, or Documentation::HowTo
+
: The iteration number.
−
can be defined and must be documented in the wiki, the categories are named based on the types of produces
+
* release
−
being produced by the iteration
+
: The release version identifier.
−
 
+
* features
−
'''Example'''
+
: TBD unordered list of iteration features where individual entries are categorized by Documentation, Learning, etc.
−
 
+
: additional sub categories such as Documentation::Process, or Development::Process, or Documentation::HowTo
−
'''Preview'''
+
: 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, ideally these iteration features have been defined in the issue tracker so that we
−
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
+
: may link from here
−
 
+
* produces
−
TBD preview for goals section
+
: TBD 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
−
'''produces'''
+
: the categories are named based on the storage being used for the individual produces of the iteration
−
 
+
* subprojects
−
unordered list of produces where individual entries are categorized by Wiki, Repository and IssueTracker
+
: TBD displays a tree of subprojects affected the iteration using an unordered list<br/>
−
additional categories can be added as required, however, they must be documented in the wiki
+
: individual items can be laid out as links to individual sub project pages in the<br/>
−
the categories are named based on the storage being used for the individual produces of the iteration
+
: wiki, if available a/o desired
−
 
+
* references
−
'''Example'''
+
: TBD provides an unordered list of references to either internal a/o external documents and other resources<br/>
−
 
+
: individual items may be categorized by reference categories, where individual categories must be named<br/>
−
<pre>
+
: by the content type of the resource referenced, e.g. Media, Files, Documents and so on
−
|produces=
+
|preview={{:OOPM:Templates:Documentation:Development:IterationStatement:1.0:Testcase}}
−
* Wiki
+
−
** [[WikiProduce1]]
+
−
** [[WikiProduce2]]
+
−
* Repository
+
−
** [[RepositoryProduce1]]
+
−
** [[RepositoryProduce2]]
+
−
* IssueTracker
+
−
** https://.../IssueTrackerProduce1
+
−
** https://.../IssueTrackerProduce2
+
−
</pre>
+
−
 
+
−
'''Preview'''
+
−
 
+
−
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
+
−
 
+
−
* Wiki
+
−
** [[WikiProduce1]]
+
−
** [[WikiProduce2]]
+
−
* Repository
+
−
** [[RepositoryProduce1]]
+
−
** [[RepositoryProduce2]]
+
−
* IssueTracker
+
−
** https://.../IssueTrackerProduce1
+
−
** https://.../IssueTrackerProduce2
+
−
 
+
−
'''subprojects'''
+
−
 
+
−
displays a tree of subprojects affected the iteration using an unordered list<br/>
+
−
individual items can be laid out as links to individual sub project pages in the<br/>
+
−
wiki, if available a/o desired
+
−
 
+
−
'''Example'''
+
−
 
+
−
<pre>
+
−
|subprojects=
+
−
* [[Requirements Analysis]]
+
−
* [[Prototype Development]]
+
−
** [[Architecture and Design]]
+
−
** [[Prototype Implementation]]
+
−
** [[Prototype Maintenance]]
+
−
</pre>
+
−
 
+
−
'''Preview'''
+
−
 
+
−
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
+
−
 
+
−
* [[Requirements Analysis]]
+
−
* Prototype Development
+
−
** [[Prototype Architecture and Design]]
+
−
** [[Prototype Implementation]]
+
−
** [[Prototype Maintenance]]
+
−
 
+
−
'''references'''
+
−
 
+
−
provides an unordered list of references to either internal a/o external documents and other resources<br/>
+
−
individual items may be categorized by reference categories, where individual categories must be named<br/>
+
−
by the content type of the resource referenced, e.g. Media, Files, Documents and so on
+
−
 
+
−
'''Example'''
+
−
 
+
−
<pre>
+
−
|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]
+
−
</pre>
+
−
 
+
−
'''Preview'''
+
−
 
+
−
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
+
−
 
+
−
* 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=
+
−
TBD include testcase for preview
+
 
}}
 
}}
−
 
+
[[Category:OOPM:Templates:Documentation:Development|I]]
−
[[Category:OOPM:Templates:Documentation|Development]]
+
</noinclude><includeonly>
−
 
+
__NOEDITSECTION__
−
</noinclude>
+
−
 
+
−
<includeonly>
+
 
=== Iteration Statement ===
 
=== Iteration Statement ===
 
{|
 
{|
 +
|'''Issue'''
 +
|{{#ifeq: {{{issue|none}}} | none | instruct the PM to define the associated (and required) issue in the tracker | {{{issue}}} }}
 +
|-
 +
|'''Release'''
 +
|{{#ifeq: {{{release|none}}} | none | not defined | [[:Category:OOPM:Development:Releases:{{{release}}}]]}}
 +
|-
 
|'''Iteration'''
 
|'''Iteration'''
 
|{{{iteration|not defined}}}
 
|{{{iteration|not defined}}}
−
|-
 
−
|'''Release'''
 
−
|[[:Category:OOPM:Development:Releases:{{{release|not defined}}}|{{{iteration|not defined}}}]]
 
 
|-
 
|-
 
|'''Previous Iteration'''
 
|'''Previous Iteration'''
−
|[[{{{previous|not defined}}}]]
+
|{{#ifexist: OOPM:Development:Releases:{{{release}}}:Iterations:{{#expr: {{{iteration|0}}} - 1}} | [[OOPM:Development:Releases:{{{release}}}:Iterations:{{#expr: {{{iteration}}} - 1}}]] | no previous iteration exists}}
 
|-
 
|-
 
|'''Next Iteration'''
 
|'''Next Iteration'''
−
|[[{{{next|not defined}}}]]
+
|[[OOPM:Development:Releases:{{{release}}}:Iterations:{{#expr: {{{iteration}}} + 1}}]] (do not create if there is no follow up iteration)
 
|}
 
|}
−
<br/>
 
  
 
==== Schedule ====
 
==== Schedule ====
  
−
{|
+
'''See the link to the associated issue above.'''
−
|'''Begin Date'''
+
−
|{{{begindate|not defined}}}
+
−
|-
+
−
|'''End Date'''
+
−
|{{{enddate|not defined}}}
+
−
|-
+
−
|'''Duration'''
+
−
|{{{duration|not defined}}}
+
−
|}
+
−
<br/>
+
  
−
==== Goals ====
+
==== Iteration Features ====
  
−
{{{goals|none defined}}}
+
{{{features|none defined}}}
  
 
==== Produces ====
 
==== Produces ====
Line 188: Line 82:
 
{{{references|no references defined}}}
 
{{{references|no references defined}}}
  
−
[[Category:OOPM:Development:Releases:{{{release|not defined}}}|Iterations]]
+
{{#ifeq: {{{release|none}}} | none | | [[Category:OOPM:Development:Releases:{{{release}}}:Iterations]]}}
  
 
----
 
----
  
−
Based on [[Template:OOPM:Templates:Documentation:Development:IterationStatement:1.0]]
+
Based on [[Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0]]
 
</includeonly>
 
</includeonly>

Latest revision as of 20:10, 8 May 2009


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-005-08

Purpose

TBD Template purpose

Synopsis

{{Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0
|issue=<HyperLink>
|iteration=<Integral>
|release=<ReleaseVersion>>
|features=<WikiMarkup>
|produces=<WikiMarkup>	
|subprojects=<WikiMarkup>	
|references=<WikiMarkup>
}}

Parameter Reference

  • issue
Hyperlink to the associated issue in the issue tracker.
  • iteration
The iteration number.
  • release
The release version identifier.
  • features
TBD unordered list of iteration features 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, ideally these iteration features have been defined in the issue tracker so that we
may link from here
  • produces
TBD 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
  • subprojects
TBD 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
  • references
TBD 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

Preview

IMPORTANT NOTICE: Do not edit a/o create the below dummy links.


Iteration Statement

Issue instruct the PM to define the associated (and required) issue in the tracker
Release Category:OOPM:Development:Releases:FooBar1.0
Iteration 1
Previous Iteration no previous iteration exists
Next Iteration OOPM:Development:Releases:FooBar1.0:Iterations:2 (do not create if there is no follow up iteration)

Schedule

See the link to the associated issue above.

Iteration Features

none defined

Produces

none defined

Subprojects

  • Foo
    • Bar
    • ooF

References

Based on Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0

Uses Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader

Retrieved from "https://wiki.openoffice.org/w/index.php?title=Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0&oldid=124096"
Personal tools