projectdoc Toolbox

Overview over the most relevant information for software developers to create their documentation on Confluence with the projectdoc Toolbox.

Audience: Documentation Architect, Author, Documentation Gardener

This tour lists information on how to use the projectdoc Toolbox with Confluence to communicate processes and artifacts used and created by a software development team.

Overview Information

The following topics provide information for software developers.

How to document a Software Development Project: There is no one-size-fits-all for documenting software projects. What we do is giving you an introduction on how to get started with the projectdoc Toolbox and the Software Development Add-on to define your documentation requirements with Confluence.
Software Architecture Documentation: Communicate the quality targets, context, and design drivers of your software architecture.
Software Project Documentation: How to start your software project documentation? Here are the steps to get started with Confluence and the projectdoc Toolbox.
Principles: List of principles for agile documentation (mostly) derived from software development principles.

Doctype Add-ons

The following free add-ons provide page and space blueprints for software development projects.

projectdoc Add-on for arc42: Provides doctypes to document a system or software architecture based on the arc42 Template.
Doctypes for Software Development: 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.
Doctypes for Agile Planning: 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 for Java Developers: A collection of blueprints for Confluence to create and work with documentation for Java projects.
projectdoc for Maven Developers: A collection of blueprints for Confluence to create and work with documentation for Maven projects.
projectdoc Developer Diaries: 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!

Extensions

The free extensions provide additional tools to document software development projects and integrate with other tools.

Information Systems Extension: Add-on to extend the projectdoc Toolbox to integrate remote information systems.
Web API Extension: Add-on to extend projectdoc with an API to access on the web.
Bookmarklets Extension: Add-on to extend the Toolkit with Bookmarklets. Allows to execute tools via the browser.
Graph Extension: Add-on to extend the projectdoc Toolbox for drawing document graphs.
Maven Extension: Add-on to extend projectdoc for Confluence with Maven Tools.

Resources

More information on projectdoc:

projectdoc Introduction: A short introduction into the concepts and features of the projectdoc Toolbox.
Tips: List of tips to use Confluence with the projectdoc Toolbox and fun! Tips address users of different experience levels.
Agile Documentation: A document is considered to follow the agile principle if it is valuable, essential, and created or updated just-in-time. A documentation is created and maintained in an agile way, if all its documents follow this practice.
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.
Hands-on Tutorial: Get started with the projectdoc Toolbox: learning by doing
projectdoc Toolbox Online Manual: The online manual for version 1 of the projectdoc Toolbox for Confluence.
Use Cases: An overview over the use cases for which the projectdoc Toolbox provides support.
Tour for Document Authors: Tour through the documentation for users who want to learn to create documents based on projectdoc doctypes.
Tours: Guided views on topics for different audiences.

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Overview Information

Doctype Add-ons

Extensions

Resources

About

Keep up-to-date!

Powered by