projectdoc Toolbox

Lists projects that use the projectdoc Toolbox for their documentation. We include real projects as well as interesting examples.

Description

We use the projectdoc Toolbox for a number of projects. For each topic we work on, we create a new space with projectdoc.

If the project requires documentation, we create a space with a blueprint provided by the Core Doctypes. If it contains records that create a result, we use projectdoc Developer Diaries to organize our daily information. The Doctypes for Agile Planning are used to organize project related information to collaborate as a team. If we want to document a software project, we use Software Development Doctypes.

So here come a few live examples that use the projectdoc Toolbox.

projectdoc

Eat your own dogfood! We have fun creating our documentation with our tool!

Name Short Description Notes
The projectdoc Toolbox supports agile teams in writing project documentation collaboratively. This is an introduction to use cases for and features of the projectdoc Toolbox.
We decided to use a space blueprint from the Core Doctypes Add-on and completely redesigned the space homepage.
The online manual for version 1 of the projectdoc Toolbox for Confluence.
We have decided to create a specialized add-on that provides templates to document Doctypes, Macros, and Doctools. The add-on is based the Core Doctypes Add-on since we target users of the plugin as the audience.

Maven Plugins

We decided to move our documentation from the XDoc format to projectdoc on Confluence. This allows us to update the information independent of the release cycles of the products. We also take advantage of templates and macros that make it much easier to create the documentation collaboratively.

PluginShort Description
Tools to manage apps on a Confluence server remotely via the UPM REST API based on Maven.
Generates build metadata and provides it as Maven build properties. The properties are written to a properties file that can be included in the generated artifact. The information can also be added to the manifest file.
doctype-maven-plugin
Create doctype add-ons (OBRs) for the projectdoc Toolbox with Confluence Blueprints based on XML model descriptions easily!
smartics-ea-maven-plugin
Integrates the Enterprise Architect (Sparx Systems) into a Maven build process. This allows to export diagrams to be used for documentation in other tools, such as projectdoc.

Demo Spaces

We provided some space online to help you visualize some space you

NameShort Description
HTML Sanity Checker Architecture Documentation
An example of an software architecture documentation based on the arc42 Template on Confluence 5 with projectdoc and the projectdoc Add-on for arc42.
projectdoc Demonstration Space
The demonstration space of projectdoc features. Create this space in your Confluence instance using a space blueprint 'projectdoc Demonstration Space'.
projectdoc New Space Demo
Get an impression on how the agile documentation space looks like!