Open issues document what the team needs to know to proceed.
- ID
open-issue- Suite
- Parent
- Documentation Type
- Categories
Description
Use the Open Issue Doctype to keep track of things the team needs to know.
Use the document as a team to contribute collaboratively to the clarification of an issue. Once a specific topic is examined and understood, add the interesting facts to the appropriate spot in your documentation space.
Properties
The document type open issue 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.
Identifier
Add a unique identifier to this issue. This makes it easier to reference it in the discussion with external stakeholders.
See Auto Increment for support of autocreation of this property.
The property is available sinve version 3.2.1 of the doctype add-on.
Type
Group open issues by their type.
A project may provide its own set of types via the Open Issue Type.
Severity
Document the severity of the impact on the project this open issue has.
A project may provide its own set of severities via the Open Issue Severity Doctype.
Drivers
Specify drivers that influence this issue.
Prior to version 3.2.1 this was supposed to be a stakeholder. But drivers may have different forms.
The property also changed from singular to plural. Add multiple drivers separated by comma.
Status
Specify the status of the open issue.
A project may provide its own set of severities via the Open Issue Status Doctype.
Reference
Add references to information on external systems here.
This may include issues on a bug tracking system.
Assignee
A stakeholder responsible of keeping track of this issue.
Sponsors
List the stakeholders that take interest in the closing of this issue.
Sections
Impact
Describe the impact the unsolved issue has on the project. This may include the working hypothesis taken until the issue is resolved.
Subordinate Issues
A complex issue may be divided into separate, smaller issues that are tackled individually.
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.
Related Doctypes
Open Issue Type
The Open Issue Type Doctype allows to organize issues by their type.