projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.
projectdoc is about document properties and document sections.
projectdoc documents are usually defined as page blueprints by the Template Author.
Page Authors select the type of document that suits their requirements and simply add content. If they add new sections they are encouraged to use the Section Macro. But if the content is not meant to be transcluded, authors may decide to use simple HTML headers.
The document type supports authors in writing documents of a given kind. Due to the nature of the templates, readers only see those properties and sections which have meaningful information.
This we call "Guided Writing & clutter-free Reading".
Transclude Sections and Properties
Modular documentation supports reuse and collaboration for your team.
Transclusion of information (i.e. include information from another page) supports single-sourcing (i.e. have information in one and only one place).
Use the Transclusion Macro or the Transclude Documents Macro to transclude sections and the display property macros (e.g. Display Document Property Macro or Display Document Properties Macro) to transclude property values.
The following resources provide information to get started with projectdoc.
- projectdoc Introduction
- A short introduction into the concepts and features of the projectdoc Toolbox.
- projectdoc Spaces
- projectdoc introduces structure on a Confluence space. It adds the concept of homepages for document types.
- projectdoc Space Relationships
- projectdoc allows to group spaces and to set them in two kinds of relationships: delegate and search.
- Learning projectdoc
- Getting started with the projectdoc Toolbox is not easy. Some basic concepts are more than just good-to-know and the number of macros and doctypes may be simply overwhelming. This tip gives some advice on how to get started.
- projectdoc Documents (2. October 2015)