Go to start of metadata
- Created by Robert Reiner, last modified on 20. Jun 2020
projectdoc Toolbox
Feature Overview?
If you have 2 minutes ...
Watch our video introduction!
If you have some more minutes ...
Read the projectdoc Introduction!
Get started now?
This article provides an overview over the highlights and features of the projectdoc Toolbox for Confluence.
Highlights
The highlights describe the main features of the projectdoc Toolbox.
- Organize Pages and Spaces
- Use or define page blueprints with properties / metadata and sections that render only if they actually contain information. Use or define space blueprints with homepages for document types for dynamic organization.
- Modular Documentation
- Use rich multi-excerpts (transclusion) for content reuse - even from page result lists. Replace parameters in excerpts. Include properties and sections from pages. Hide content dependent on roles and properties.
- Enhance Navigability
- Add new content to be dynamically listed in existing documents. Create complex property reports with a Select-From-Where syntax. Transclude or link to texts fragments and images locally or on remote servers.
Use Cases
In Use Cases we describe a number of use cases where the features of the projectdoc Toolbox support teams with their documentation tasks.
List of Features
The list of features of the projectdoc Toolbox to support teams to create and maintain documentation in a wiki.
If you like to see all features on one page, then go to Features on one Page!
- Document Types
- Document types allow to guide authors producing information of a given type. They also help readers to find the information they are looking for quickly.
- Rich Custom Document Metadata
- Authors may add any metadata to a document and use these in their queries. The metadata may be displayed or hidden. This way authors can use metadata target at the reader and metadata used for authoring purpose.
- Enhanced Transclusion
- Transclude more than one self-contained snippet and mark transcluded information for authors. The projectdoc toolbox allows multi-transclusion from one document and even several documents.
- Dynamic Linking
- A document template that uses query macros enables documents to dynamically render links to a set of related documents. If new documents are added to the system that meet the query criteria, links to these documents are automatically added to the querying document. This feature is also called dynamic lists or automatic linking.
- Guided Writing & clutter-free Reading
- Do not clutter the view with non-information sections. Instead help authors writing identical structured content by the use of templates.
- Space Properties
- Properties may be set on space level and are inherited through space hierarchies.
- Space Hierarchies
- Organize spaces in hierachies with delegate and search spaces.
- Default Locations
- Document types have their default location within a documentation space. These default locations are called 'homepages'. If authors create new documents they can send them to these default locations within a given space. Delegate spaces expand this feature to find the default location in associated spaces.
- Single Sourcing
- The projectdoc Toolbox provides doctypes and macros to support teams to modularize their documentation.
- Delegate Document
- Delegating documents transclude sections and properties from a delegate document. Information may be overridden.
- Live Templates / Impersonator
- Use the structure from a page and render it in the current page's context.
- Deep Links
- With deep links properties from referenced properties can be accessed for rendering.
- Web API
- To integrate projectdoc documents with remote systems the projectdoc Toolbox provides a REST API. This API is installed separately with a free extension add-on.
- Information Systems Integration
- Via a free extension information from remote information systems may be rendered on a wiki page.
- Remote Control
- The projectdoc Toolbox supports rendering a page controlled by request properties. This way a URL controls the contents of a page.
- Extensible by Spaces, Templates, and Macros
- Never be limited to the vendor's ideas: Create your own spaces, templates/blueprints/doctypes and macros based on components provided by the projectdoc Toolbox!
- Variables
- Space and document properties may be used as variables with the projectdoc Toolbox.
Resources
More resources on tools and procedures provided by the projectdoc Toolbox.
- Agile Documentation
- Information on agile documentation: from values to principles and practices. A set of actionable tools for team communication.
- Macros
- List of macros provided by the projectdoc Toolbox.
- Doctypes
- Doctypes define properties and sections for documents. They are essentially Confluence Blueprints that help to create pages in your wiki based on templates.
- projectdoc Extensions
- Extensions augment the projectdoc Toolbox. Features that are not relevant for all users are separated and may be installed on-demand by customers of the Toolbox.
- Use Cases
- An overview over the use cases for which the projectdoc Toolbox provides support.
- Show Cases
- A set of Confluence spaces showing projectdoc in action.
- Agile Documentation
- Information on agile documentation: from values to principles and practices. A set of actionable tools for team communication.
