You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

projectdoc Toolbox

Tour through the documentation for users that want to create documents based on projectdoc doctypes.

Audience

This tour guides you to the information that is relevant for document authors to get to know the relevant doctypes, macros and conventions of projectdoc quickly.

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.

Concepts

Basic Concepts and Conventions for projectdoc is a selection of topics that will introduce the central conventions of projectdoc.

Knowing them will make it easier for you to use doctypes and macros.

Core Doctypes

Take a gentle introduction to the doctypes provided by the core doctypes add-on.

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.


 

If you just need to have an overview of the existing types, please check the Doctypes page.

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.

Referencing Macros
Macros to help authors to reference other documents that are relevant to the current document.
Structuring Macros
Macros to help authors to a document structure so that the information is easier to understand.
Modular Documentation Macros
Macros to support single sourcing for creating modular documents.
Visual Macros
Macros to render information in a visually appealing format.
Document Development Macros
Macros that help authors to create templates and content.
Collaboration Macros
Macros to support a team to write their documentation collaboratively.

An alternative View on projectdoc Macros

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.

NameStatusShort Description
Doctypes for Software DevelopmentAVAILABLE
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 arc42AVAILABLE
Provides doctypes to document a system or software architecture based on the arc42 Template.
Doctypes for Agile PlanningAVAILABLE
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 DiariesAVAILABLE
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 DevelopersAVAILABLE
A collection of blueprints for Confluence to create and work with documentation for Java projects.
projectdoc for Maven DevelopersAVAILABLE

A collection of blueprints for Confluence to create and work with documentation for Maven projects.

Doctypes for TeamworkAVAILABLE
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 StrategyAVAILABLE
Mission, vision, strategy for business planning and execution.
Doctypes for Service ManagementAVAILABLE
Provides doctypes to document services and systems for IT service management (ITSM).
Doctypes for Project ManagementAVAILABLE
Provides doctypes for documenting decisions, risks, open issues, and meeting minutes.
Doctypes for Risk ManagementAVAILABLE SOON
Provides doctypes for documenting and tracking risks.
Doctypes for App ManualsAVAILABLE SOON
Document macros, page blueprints, space blueprints, and components of your Confluence add-on.
Doctypes for V-Modell®XTAVAILABLE
Use products (templates) from the V-Modell®XT in your Confluence wiki as blueprints!
Doctypes for Conversation, Feedback, RecognitionPOSTPONED
Use CFRs to implement continuous performance management in your wiki.
Impact MappingPOSTPONED
Analyse the impact you can make.
LeanPOSTPONED
State assumptions and hypotheses to run your experiments. Document your output and plan for outcome and impact.
Objectives and Key ResultsPOSTPONED
Use OKRs to define your objectives and focus on your key results.

  • No labels