- Created by Robert Reiner, last modified on 19. Apr 2019
projectdoc Toolbox
Generic Documents provide information where no other doctype matches.
- ID
generic- Suite
- Documentation Type
- Categories
- Tags
Description
A generic doctype is used whenever no specific doctype is available or not required. Generic doctypes often help to split a larger document of any type into separate modules. Other than topics, generic doctypes do never stand for themselves and always closely belong to their parent document.
Properties
The document type generic 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.
Sections
Description
The description section of a document informs about its content and intention. This is a descriptive abstract, similar to a table of contents, and a longer form of the Short Description document property.
The description helps potential readers to decide, whether or not relevant information can be found in the document.
Some document types may interpret this property different. A Glossary Item for instance, puts the definition of the term in the description section. A Role describes the role instead of describing what the intention of a particular role document instance is.
Since the location of this section typically makes the intention of the text obvious, the section title may be hidden. For more information please refer to No need to render the Section Title in Tips.
Summary
Summarize the key findings or essential information of the document. This is the informative abstract, while a Description contains the descriptive abstract.
The summary helps readers to get informed about the key points in a short section. It is also a tool to help readers of the document to recall the contents without scanning the whole 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.
Details
Storage Format
If you like to create a template for projectdoc, you should consider to provide the standard properties and sections that are provided by the generic doctype.
<ac:structured-macro ac:name="projectdoc-properties-marker">
<ac:rich-text-body>
<div class="table-wrap">
<table>
<tbody>
<tr>
<th>Short Description</th>
<td>
<ac:placeholder>Add short description in about 1 to 3 sentences.</ac:placeholder>
</td>
<td> </td>
</tr>
<tr>
<th>Doctype</th>
<td>my-doctype</td>
<td>hide</td>
</tr>
<tr>
<th>Name</th>
<td>
<ac:placeholder>The unique name of the document within the doctype.</ac:placeholder>
</td>
<td> </td>
</tr>
<tr>
<th>Parent</th>
<td>
<ac:structured-macro ac:name="projectdoc-transclusion-parent-property">
<ac:parameter ac:name="property-name">Name</ac:parameter>
</ac:structured-macro>
</td>
<td> </td>
</tr>
<tr>
<th>Audience</th>
<td>
<ac:structured-macro ac:name="projectdoc-name-list">
<ac:parameter ac:name="property">Audience</ac:parameter>
<ac:parameter ac:name="doctype">role</ac:parameter>
</ac:structured-macro>
</td>
<td> </td>
</tr>
<tr>
<th>Categories</th>
<td>
<ac:structured-macro ac:name="projectdoc-name-list">
<ac:parameter ac:name="property">Categories</ac:parameter>
<ac:parameter ac:name="doctype">category</ac:parameter>
</ac:structured-macro>
</td>
<td> </td>
</tr>
<tr>
<th>Tags</th>
<td>
<ac:structured-macro ac:name="projectdoc-tag-list-macro">
<ac:parameter ac:name="property">Tags</ac:parameter>
</ac:structured-macro>
</td>
<td> </td>
</tr>
<tr>
<th>Iteration</th>
<td>
<ac:structured-macro ac:name="projectdoc-iteration">
<ac:parameter ac:name="value">facade</ac:parameter>
</ac:structured-macro>
</td>
<td> </td>
</tr>
<tr>
<th>Sort Key</th>
<td>
<ac:placeholder>Add a character sequence to support sorting documents.</ac:placeholder>
</td>
<td>hide</td>
</tr>
</tbody>
</table>
</div>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="projectdoc-section">
<ac:parameter ac:name="title">Description</ac:parameter>
<ac:rich-text-body>
<ac:placeholder>Describe the content of this document so that readers are able to decide whether to read further or not.</ac:placeholder>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="projectdoc-section">
<ac:parameter ac:name="title">Notes</ac:parameter>
<ac:parameter ac:name="required-permissions">write-access</ac:parameter>
<ac:rich-text-body>
<ac:placeholder>Add project-private notes to the document. This information is not intended to be exported to other parties and is usually only read-able by users with write access. The information is NOT secured. The section is for convenience of the reader. Do NOT add any confidential information to this section!</ac:placeholder>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="projectdoc-section">
<ac:parameter ac:name="title">References</ac:parameter>
<ac:rich-text-body>
<ac:placeholder>List sources that back the information in the document. This are references to the original source of the information. May reference a domain expert or/and some other documents. Add hyperlinks, if possible.</ac:placeholder>
</ac:rich-text-body>
</ac:structured-macro>
<ac:structured-macro ac:name="projectdoc-section">
<ac:parameter ac:name="title">Resources</ac:parameter>
<ac:rich-text-body>
<ac:placeholder>Reference other resources that relate to this document. May include further readings or alternative information.</ac:placeholder>
</ac:rich-text-body>
</ac:structured-macro>
Related Doctypes
Tours
Tours are used to aggregate other document instances, especially topics. They are of a means to take an alternative walk through the documentation.
Topics
Topics provide information about a certain subject. They are the basic modules of the documentation and are used where no more specific document type fits.
