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

From Apache OpenOffice Wiki
Jump to: navigation, search
(→‎Iteration Statement)
Line 13: Line 13:
 
</noinclude>
 
</noinclude>
  
−
=== Iteration Statement ===
 
 
<noinclude>
 
<noinclude>
−
DO NOT EDIT THE BELOW REFERENCED '''not defined''' PAGES
+
{{Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader:1.0
−
</noinclude>
+
|author=Carsten Klein "rts" <carsten.klein@abstraxion.de>
 +
|created=2009-04-07
 +
|purpose=
 +
TBD Template purpose
 +
|synopsis=
 +
Templates:OOPM:Templates:Documentation:Development:IterationStatement:1.0
 +
&#124;iteration=<Integral> // the iteration number
 +
&#124;release=<ReleaseVersion>> // the release version targetted by the iteration
 +
&#124;goals=<WikiMarkup> // standard wiki markup formulating the goals for this iteration
 +
&#124;produces=<WikiMarkup> // standard wiki markup stating the expected produces of the iteration
 +
&#124;subprojects=<WikiMarkup> // standard wiki markup stating the affected/active subprojects for this iteration
 +
&#124;references=<WikiMarkup> // standard wiki markup providing references to internal a/o external resources
 +
|parameters=
 +
'''goals'''
  
−
{|
 
−
|'''Iteration'''
 
−
|{{{iteration|not defined}}}
 
−
|-
 
−
|'''Release'''
 
−
|[[:Category:OOPM:Development:Iterations|{{{release|not defined}}}]]
 
−
|-
 
−
|'''Previous Iteration'''
 
−
|[[{{{previous|not defined}}}]]
 
−
|-
 
−
|'''Next Iteration'''
 
−
|[[{{{next|not defined}}}]]
 
−
|}
 
−
<br/>
 
−
 
−
==== Schedule ====
 
−
 
−
{|
 
−
|'''Begin Date'''
 
−
|{{{begindate|not defined}}}
 
−
|-
 
−
|'''End Date'''
 
−
|{{{enddate|not defined}}}
 
−
|-
 
−
|'''Duration'''
 
−
|{{{duration|not defined}}}
 
−
|}
 
−
<br/>
 
−
 
−
==== Goals ====
 
−
 
−
{{{goals|none defined}}}
 
−
 
−
<noinclude>
 
 
unordered list of goals where individual entries are categorized by Documentation, Learning, etc.
 
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
 
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
 
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
 
being produced by the iteration
−
</noinclude>
 
  
−
==== Produces ====
+
'''Example'''
  
−
{{{produces|none defined}}}
+
'''Preview'''
 +
 
 +
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
 +
 
 +
TBD preview for goals section
 +
 
 +
'''produces'''
  
−
<noinclude>
 
 
unordered list of produces where individual entries are categorized by Wiki, Repository and IssueTracker
 
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
 
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
 
the categories are named based on the storage being used for the individual produces of the iteration
  
−
example
+
'''Example'''
  
 
<pre>
 
<pre>
 
|produces=
 
|produces=
−
* Wiki
+
* Wiki
−
  * [[WikiProduce1]]
+
** [[WikiProduce1]]
−
  * [[WikiProduce2]]
+
** [[WikiProduce2]]
−
* Repository
+
* Repository
−
  * [[RepositoryProduce1]]
+
** [[RepositoryProduce1]]
−
  * [[RepositoryProduce2]]
+
** [[RepositoryProduce2]]
−
* IssueTracker
+
* IssueTracker
−
  * https://.../IssueTrackerProduce1
+
** https://.../IssueTrackerProduce1
−
  * https://.../IssueTrackerProduce2
+
** https://.../IssueTrackerProduce2
 
</pre>
 
</pre>
−
</noinclude>
 
  
−
==== Subprojects ====
+
'''Preview'''
  
−
{{{subprojects|none defined}}}
+
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
  
−
<noinclude>
+
* Wiki
−
'''Purpose of this section'''
+
** [[WikiProduce1]]
 +
** [[WikiProduce2]]
 +
* Repository
 +
** [[RepositoryProduce1]]
 +
** [[RepositoryProduce2]]
 +
* IssueTracker
 +
** https://.../IssueTrackerProduce1
 +
** https://.../IssueTrackerProduce2
 +
 
 +
'''subprojects'''
  
 
displays a tree of subprojects affected the iteration using an unordered list<br/>
 
displays a tree of subprojects affected the iteration using an unordered list<br/>
Line 105: Line 95:
 
</pre>
 
</pre>
  
−
'''Preview (DO NOT EDIT THE LINKED TO DUMMY PAGES)'''
+
'''Preview'''
 +
 
 +
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
  
 
* [[Requirements Analysis]]
 
* [[Requirements Analysis]]
Line 112: Line 104:
 
** [[Prototype Implementation]]
 
** [[Prototype Implementation]]
 
** [[Prototype Maintenance]]
 
** [[Prototype Maintenance]]
−
</noinclude>
 
  
−
==== References ====
+
'''references'''
−
 
+
−
{{{references|no references defined}}}
+
−
 
+
−
<noinclude>
+
−
'''Purpose of this section'''
+
  
 
provides an unordered list of references to either internal a/o external documents and other resources<br/>
 
provides an unordered list of references to either internal a/o external documents and other resources<br/>
Line 137: Line 123:
 
</pre>
 
</pre>
  
−
'''Preview (CLICKING ON DUMMY LINKS PROVES THE NATURE OF ONE'S SELF)'''
+
'''Preview'''
 +
 
 +
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
  
 
* Documents
 
* Documents
Line 145: Line 133:
 
* Files
 
* Files
 
** [http://foo/bar_draining.java sample source implementing a bar draining algorithm]
 
** [http://foo/bar_draining.java sample source implementing a bar draining algorithm]
 +
|preview=
 +
TBD include testcase for preview
 +
}}
 +
 +
[[Category:OOPM:Templates:Documentation|Development]]
 +
 
</noinclude>
 
</noinclude>
  
 
<includeonly>
 
<includeonly>
−
[[Category:OOPM:Development:Iterations|{{{release|not defined}}}]]
+
=== Iteration Statement ===
 +
{|
 +
|'''Iteration'''
 +
|{{{iteration|not defined}}}
 +
|-
 +
|'''Release'''
 +
|[[:Category:OOPM:Development:Releases:{{{release|not defined}}}|{{{iteration|not defined}}}]]
 +
|-
 +
|'''Previous Iteration'''
 +
|[[{{{previous|not defined}}}]]
 +
|-
 +
|'''Next Iteration'''
 +
|[[{{{next|not defined}}}]]
 +
|}
 +
<br/>
 +
 
 +
==== Schedule ====
 +
 
 +
{|
 +
|'''Begin Date'''
 +
|{{{begindate|not defined}}}
 +
|-
 +
|'''End Date'''
 +
|{{{enddate|not defined}}}
 +
|-
 +
|'''Duration'''
 +
|{{{duration|not defined}}}
 +
|}
 +
<br/>
 +
 
 +
==== Goals ====
 +
 
 +
{{{goals|none defined}}}
 +
 
 +
==== Produces ====
 +
 
 +
{{{produces|none defined}}}
 +
 
 +
==== Subprojects ====
 +
 
 +
{{{subprojects|none defined}}}
 +
 
 +
==== References ====
 +
 
 +
{{{references|no references defined}}}
 +
 
 +
[[Category:OOPM:Development:Releases:{{{release|not defined}}}|Iterations]]
  
 
----
 
----
Line 154: Line 194:
 
Based on [[Template:OOPM:Templates:Documentation:Development:IterationStatement:1.0]]
 
Based on [[Template:OOPM:Templates:Documentation:Development:IterationStatement:1.0]]
 
</includeonly>
 
</includeonly>
−
 
−
[[Category:OOPM:Templates:Documentation|Development]]
 

Revision as of 18:26, 8 April 2009

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

Purpose

TBD Template purpose

Synopsis

{{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.

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.

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.

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

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