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.

  

Take an alternative introduction to the Doctypes for Software Development

English and German by Default

 

All doctype add-ons are available in English and German language (except for the V-Modell XT add-on for which only German is supported).

For more information on this topic please refer to Localization.

Overview

The Doctypes for Software Development help agile teams to document their software architecture.

Create a space and you have a basic structure, a repository, to add the relevant information for your stakeholders.

Author's Dashboard vs. Landing Page

The screenshot on the left shows the author's view. It contains links to documentation modules and types, tags, categories you usually want to see as an author, but not as a reader. See it as the authors' working dashboard. The space homepage contains the links that are relevant for readers. It is the landing page of the space.

This is the landing page provided by the The Software Development Add-on:

It leaves more space to add information most relevant to the readers of this space.



After you have created your space use the page blueprints to create documents for project constraints, requirements, views, architecture aspects (aka concepts) and many more.

The different topics are part of a document that comprise usually one wiki page. Since these pages are loosely coupled, they can be combined for different audience groups (e.g. using Tours or Volumes) easily. This makes it natural to run single source documentation principles and employ advanced features like transclusions or automatic lists. If the concepts you want to discuss are complex, you are not limited to a single page. Use the Section or other doctypes to create pages for modular content.

Due to home and index pages it is easier for authors to store new documents.

Install additional Doctypes!

Prerequisites

The Doctypes for Software Development requires the projectdoc Toolbox to be installed. The projectdoc Toolbox has a commercial license.

The add-on also uses blueprints from the Core Doctypes for projectdoc (like Role or Stakeholder). This add-on is available on the Atlassian Marketplace for free.

Please install the following add-ons on your Atlassian Confluence server:

1. Install projectdoc Toolbox

List of Doctypes for Software Development

The following doctypes help to document your software projects.

 

This list can be overwhelming, but using the templates is usually quite straight forward. To get a quick overview we suggest to open the Prezi presentation (the one we mentioned on the top of the page) which groups the logically closely related document types.

Mind some basics given in How to document a Software Development Project?

For an introduction to using projectdoc doctypes and macros from the author's point of view, have a look at the following documents:

 

To organize your information about your software or system, you should have a look at the projectdoc Add-on for arc42. The arc42 Template provides a standard layout of chapters.

On the arc42 Template you can find a lot of useful tips on documenting architectures.


The query matched no documents.

Related Macros

The following macros are provided by this add-on.

Resources

  • Doctypes - more doctypes for projectdoc.
  • Macros - macros to be used in your doctype templates.