Charter

...

Document Properties Marker

override	false

Short Description Describes an information need and use this description as a basis to create and maintain a document.

Doctype doctype hide

Name Charter

ID charter

Suite Core

Set Core hide

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience

Documentation Type

Name List

doctype	doctype-type
render-no-hits-as-blank	true
names	Q2 - Project
property	Documentation Type

Tags

Tag List

names	Core, Modular Documents

Iteration

value

filled

released

hide

Since 5.1

Sort Key hide

Section

index	true
show-title	false
title	Description

Agile documentation is about to provide information that is really needed. Agile documentation needs to be valuable, essential, and available just-in-time.

Therefore a stakeholder is required to define what is required, to what extend, and at which time.

A charter document starts a documentation session by defining what is required.

...

Section

title	Properties

Transclusion

document	Note Box referencing common Document Properties
ids	Box

Section

title	Type

The Charter Type allows to organize charters by type.

Section

title	Timebox

Define the timebox within to run the session.

Section

title	Documented Information Type

Define the documented information type of the new document as either document or record.

Definition List

document

A document is required to be kept up-to-date. Therefore there is an ongoing maintenance cost until the document is deprecated or removed.

record

The record is just an information that is up-to-date at the instance of its creation. It may serve as a source of information that was valid in the past. It is never updated and therefore does not require resources for maintenance. It may be edited if it contains errors or it may be updated if it is deemed useful by the team or stakeholders. But it should never be considered to be accurate without further inquiry of the stakeholders and experts.

Section

title	Sponsors

Specify a list of stakeholders that are interested in the information and therefore sponsor it.

Section

title	Experts

List the names of stakeholders who may provide additional information on the area being examined.

Section

title	Documentation Root

Add a reference to the root of the documentation created based on this charter.

This allows interested stakeholders to navigate to the created documents quickly.

...

Section

title	Sections

Section

title	Description

Document the purpose of this charter. This may contain the whole charter information in a couple of sentences.

Section

title	Summary

Write a short summary about the result intended for team members and other stakeholders

Section

title	Mission

State where the exploration is taking place.

Section

title	Tools

List the tools to employ to run the exploration.

Section

title	Information

List the information the sponsors are interested in. May state a problem to be solved.

Section

title	Subordinate Charters

Teams may want to break a larger charter into smaller charters to have several, more focussed sessions. In this case add the additional charters as child pages to this document. Keep in mind that the child relationship indicated that if - for some reason - the parent charter is removed, all children should be removed, too. If this is not the case, better add the charters to the homepage.

Transclusion

document	Document Sections
ids	standard-sections-bottom

Section

title	Details

Section

index	true
title	Related Doctypes

Section

index	true
title	Sub-Doctypes

Display Table

doctype	doctype
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

...

Section

title	Notes

Section

title	References

projectdoc-tour-macro

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description

projectdoc-section

title	Resources

Tour

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description
Paperwork
Domain Crunching
Changelog Macro

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-doctype
Type	core

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 4

New Version Current

Key

About

Keep up-to-date!

Powered by