Documentation targeting at the team's application of their process.
Doctypes of this Type
Name | Short Description |
---|---|
Credentials for development systems where the password is known to all who have access to the Confluence wiki. |
|
Announcements are a way to communicate an important piece of information with your team. |
|
Document a possible option for an architecture decision. Choose this document type to describe the alternative for a decision in more detail. This is typically a subpage of an architecture decision document. |
|
Document a architecture decision for an option. This is useful to state the reasons and the options that have been evaluated. Later other team members will have it easier to understand the decision. |
|
Artifact types categorize artifacts. |
|
Associates two documents. |
|
Document assumptions to assess risks and opportunities for the project. |
|
Describes an information need and use this description as a basis to create and maintain a document. |
|
Code types categorize codes, used in logging or exception handling. |
|
Component types categorize components. |
|
Data type types categorize data types. |
|
Document a decision for an option. This is useful to state the reasons and the options that have been evaluated. Later other team members will have it easier to understand the decision. |
|
Deployments provide information about updates on services and systems to users. |
|
Record a deployment to a IT system. |
|
Document logical or physical groups of nodes. |
|
Excerpts are abstracts of information found in a resource, such as a book. If you want to go into more detail for a given resource, there may be multiple excerpts as subpages of the resource document. |
|
FAQs help to record an answer to a frequently asked question concerning the project, the product, the system or the process. |
|
Feature types categorize features. |
|
Generic Documents provide information where no other doctype matches. |
|
Improvement proposals help to start the conversation within the team for process improvements. |
|
Document an Iteration that may be linked from JIRA. Allows the team to set the goal and add notes relevant to a particular iteration. |
|
Record the action items of a meeting. |
|
A documentation module is a fragment which is usually transcluded by other documents. The lifetime of a module document is independent of the lifetimes of the documents that reference it. |
|
Nodes are part of environments where artifacts are deployed to. |
|
Node types categorize nodes. |
|
Open issues document what the team needs to know to proceed. |
|
Document and track identified opportunities for the project. |
|
Information about organizations that take a part in the project. You may collect common information here for all persons that belong to an organization, such as address or homepage. |
|
Out Items record topics that are out of the scope of the project. This is useful for project inception and for reference in the future. |
|
Out item types categorize out items. |
|
Patterns provide solutions for problems in a given context. Patterns are usefull in multiple areas such as design, architecture, documentation, or process. |
|
Provides information about a person. This includes contact information (important if the person is relevant for the team) or information about the competences (if the person is an author about a topic relevant for the project). |
|
Document problems as a means to communicate the details and to use the information for reviews and retrospections. |
|
Product Backlogs are means to collect user stories. |
|
Profiles provide views on documents via delegation. |
|
Project Constraints limit the options of a project. |
|
Project constraint types categorize project constraints. |
|
Frame the vision for a project or iteration. |
|
Property types categorize properties of products, such as parameters or configuration options. |
|
Documents a quality target for a product. |
|
Document changes provided by a release of a product. |
|
Reports document what the team has decided or done. This is a generic document. |
|
Documents requirements of a product. |
|
Record the discussion of the team about their last iteration. |
|
Plan and run your review meeting. |
|
A single act to show on the review. Use this only if you have a lot to show or you want to reference the review results later. Often a simple numerated list is sufficient. |
|
Document and track identified risks for the project. |
|
Document actions to prevent or reduce the negative impact on exceptions on a project. |
|
Document targets of risks. |
|
Sections of a document are typically part of a document. But the size of sections may vary. To support a team to write collaboratively on the documentation, a larger document may be subdivided into external section documents. |
|
Compile other documents, yet space indices are themselves projectdoc documents. So they can be tagged and grouped. |
|
A party that takes interest in a project. The stakeholder is either a real person, an organization or group, or represents a class of individuals, groups or organizations. |
|
Describes a single step of an activity. A step is a generic document that is associated with a document that describes a process. It may be a test log or a howto. |
|
Document processes defined and used by the team. |
|
Technical Debts track issues to be paid back. |
|
Document tools used by the team. Add information about how to fetch, install and best practices using it. |
|
A description of a given topic. A topic may describing or explaining a concept, a task to accomplish or a reference. There are a couple of topic types that set the expectations for the reader. Instances of the topic doctype usually have independent lifetimes from any referencing documents. |
|
Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic. |
|
User Characters are the actors of user stories. They include personas and extreme characters. |
|
User Stories document a requirement of a stakeholder with a specific business goal. It also provides an acceptance test. It is a representation of a unit of work. |