- Created by Robert Reiner, last modified on 14. Nov 2018
projectdoc Toolbox
Document an Iteration that may be linked from JIRA. Allows the team to set the goal and add notes relevant to a particular iteration.
- ID
iteration- Suite
- Parent
- Documentation Type
- Categories
- Tags
Description
Start an iteration and collect everything interesting piece of information encountered. You may link this iteration with JIRA. The iteration document allows the team to set the goal and add notes relevant to a particular iteration. Aggregated Information may be moved to a public accessible location in your wiki or remain in the iteration for later reference.
The iteration page is therefore a kind of diary, allowing to add information collaboratively. But there is no burden on maintaining the information on this page and its subpages. After the iteration is completed, all information not propagated to the documentation wiki simply get archived.
Closely related are the Review and Retrospective Doctype.
Properties
The document type iteration provides the following properties:
Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.
Goal
Specify the goal of this iteration to help your team stay focussed.
Duration
Log the start and end date of the duration. If you track your iterations in JIRA and do not need to select on this property in queries, leave it blank.
Team
List the members of the team that take part in the iteration.
Teams may not change often, so you may want to list the team members on another document and transclude them here. If you have only one team in this space, leave it blank and use it only if for some iteration the team size has been reduced (e.g. due to holidays).
Reference
Add references to information on external systems here. Probably this is an issue on your JIRA server.
Sections
Description
Describe the objectives of the iteration.
This should help the business members to have a brief summary of what business value is produced by the team within this iteration.
User Stories
List the stories that have been selected by the team for this iteration.
Each story document is a place to share information relevant for implementing the story. You may want to add information to collect for later documentation in your wiki.
Working Documents
If you have information you want to work on later in the iteration, add a working document. This is especially useful if this information is relevant for more than one user story.
Adding such information in written form may help to not forget what may be relevant in the future. The team usually looks through these notes at the end of the iteration to
Subordinate Iterations
Each document type has child document support, so does the Iteration Doctype.
Usually this is not used. In the end you have one iteration for one team. But in some cases you want to create an iteration document for some members to work together. A working document is usually preferred.
Review
Take notes on what you want to present to your stakeholders on the review of the iteration. Use the Review doctype to create this document.
Retrospective
Note what worked and what did not with this iteration. Use the Retrospective doctype to create this document.
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
The text of notes sections is also indexed.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
For further information please refer to References and Resources.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
For further information please refer to References and Resources.
