Tour through the documentation for users who want to learn to create documents based on projectdoc doctypes.
Quick Overview
projectdoc in Action is a series series of screencasts that provides some overview and hands-on videos.
Watching them will get you an impression of what projectdoc can do for you.
Core Doctypes
Take a gentle introduction to the doctypes provided by the core doctypes add-on.
Doctypes are essentially templates for various types of documents that help you get startet quickly.
The list groups the core doctypes semantically. This may help new users to learn about the core doctypes and to know when to use which.
- Generic Categories
- Categories that are defined to be used with any doctype. So any document instance defined for these categories has to make sense for any doctype.
- Type-specific Categories
- Categories that are defined to be used for a specific doctype. May be used for a couple of doctypes, but is not intended to make sense for any doctype.
- Aggregating Doctypes
- Doctypes to help organize the space. This includes homepages for particular information (like the homepages for each doctype) and tours that provide a specific view on existing documentation.
- Modular Content Doctypes
- Doctypes that help to write modular documentation and therefore support single sourcing.
- Documenting Doctypes
- These are the generic working horses that are used whenever no specific doctype matches the intention of the author.
- Subordinate Documents
- Subdocuments are associated with the lifetime of the parent document. The section doctype is the most generic type of document, but there are others, that are specific to a certain doctype.
- Specific Doctypes
- A list of doctypes that have a specific purpose. The core doctypes are none-the-less quite generic so that they can be used in almost any project.
- Generic Doctypes
- What if no existing doctype matches the purpose of the document? Here are some tips how to handle this situation.
Macros
Take a gentle introduction to the macros provided by the projectdoc Add-on.
The list groups the core macros semantically. This may help new users to learn about the core macros and to know when to use which.
Extension Doctypes
The following doctypes are provided by extension add-ons.
Cannot find content to transclude!
Please check the reference (ids=Description / tags=) to the document 'Doctype Available soon Notice' to transclude from.
If you want to silence this message on missing content, check 'Missing Content Message'.
Please refer to the Transclusion Macro documentation for more information about this macro.
| Name | Status | Short Description |
|---|
| Doctypes for Software Development | AVAILABLE | Provides doctypes to create documentation in software development projects. The focus is on documenting the architecture of the product, but it includes templates for other software development documentation requirements as well. |
| projectdoc Add-on for arc42 | AVAILABLE | Provides doctypes to document a system or software architecture based on the arc42 Template. |
| Doctypes for Agile Planning | AVAILABLE | Provides doctypes to collborate with your team. Run iterations and record discoveries that may be of interest at the end of the iteration or for even later reference. Quick notes are more easily added as records to the team's space than to the official documentation tree. Defer the talk to the documentation architect to the end of the iteration (if the discovery is still of interest). |
| projectdoc Developer Diaries | AVAILABLE | Provides doctypes to organize the developer's work by the employment of a diary. Take you personal planning and professional records to the next level! |
| projectdoc for Java Developers | AVAILABLE | A collection of blueprints for Confluence to create and work with documentation for Java projects. |
| projectdoc for Maven Developers | AVAILABLE | A collection of blueprints for Confluence to create and work with documentation for Maven projects. |
| Doctypes for Teamwork | AVAILABLE | Provides doctypes to define the checklists, processes, patterns, tools, and rules your team agrees upon. Writing them down makes them accessible for anyone - especially for new team members. Keep these documents short and to the point! |
| Doctypes for Business Strategy | AVAILABLE | Mission, vision, strategy for business planning and execution. |
| Doctypes for Service Management | AVAILABLE | Provides doctypes to document services and systems for IT service management (ITSM). |
| Doctypes for Project Management | AVAILABLE | Provides doctypes for documenting decisions, risks, open issues, and meeting minutes. |
| Doctypes for Risk Management | AVAILABLE SOON | Provides doctypes for documenting and tracking risks. |
| Doctypes for App Manuals | AVAILABLE SOON | Document macros, page blueprints, space blueprints, and components of your Confluence add-on. |
| Doctypes for V-Modell®XT | AVAILABLE | Use products (templates) from the V-Modell®XT in your Confluence wiki as blueprints! |
| Doctypes for Conversation, Feedback, Recognition | POSTPONED | Use CFRs to implement continuous performance management in your wiki. |
| Impact Mapping | POSTPONED | Analyse the impact you can make. |
| Lean | POSTPONED | State assumptions and hypotheses to run your experiments. Document your output and plan for outcome and impact. |
| Objectives and Key Results | POSTPONED | Use OKRs to define your objectives and focus on your key results. |
