Doctypes help authors to add their information in a uniform way. This uniform way support the authors to concentrate on the content and not be distracted by formatting or coarse structuring issues. It also helps readers to find the information more quickly. Tip Box |
---|
title | Teams should only write documentation that is essential and valueable |
---|
| Templates are only a tool. If the information demands it, authors are free to add or adapt the templates to their needs. It is the ease of accessing information that counts, not the adherence to standards. Please keep in mind to discuss deficiencies with your team members and documentation architects to continuously improve the documentation structure and tools. Keep your documentation essential, valuable and write it just-in-time! We assembled some quotes according to documentation writing on the projectdoc homepage. Get inspired on how to design your project documentation! |
Doctypes are implemented as page blueprints, which Confluence allows to adjust to your needs. Teams should decide what elements are worthy to use and which should be discarded. After all there must be a return of investment and every asset, which includes documents, is also a (potential) liability. To get you started with projectdoc quickly we recommend to install the Core Doctypes. With this basic set of blueprints you may start spaces to document topics that are relevant for your team. We also provide (and plan to provide) additional doctype add-ons for other areas of project documentation. The projectdoc Add-on provides only a demonstration space and the Blank Document doctype. Hide From Reader |
---|
Create from template |
---|
spaceKey | PDAC1 |
---|
blueprintModuleCompleteKey | de.smartics.atlassian.confluence.smartics-doctype-addon-app:projectdoc-blueprint-doctype-doctype |
---|
contentBlueprintId | 163a2a76-deab-4f9c-9a7d-7db675bfd7ac |
---|
templateName | 163a2a76-deab-4f9c-9a7d-7db675bfd7ac |
---|
createResult | edit |
---|
buttonLabel | New Doctype |
---|
|
|
|