Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
idDescription
titleOverview
Section
Column
width65%

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.

Column
width35%
Panel
borderColordarkgrey
titleBGColoryellow
titleAuthor'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.

 

 

Section
Column

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.

Column
width30%
Panel
titleColorwhite
titleBGColororange
titleInstall additional Doctypes!

Install additional Doctype Add-ons now and for free via

Atlassian Marketplace

Section
titlePrerequisites

The Doctypes for Software Development uses requires the PDAC1 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:

Section
Column
width50%
Panel
titleColorwhite
titleBGColororange
title1. Install projectdoc Toolbox

Install add-on now

Atlassian Marketplace

Column
width50%
Panel
titleColorwhite
titleBGColororange
title2. Install Core Doctypes!

Install the Core doctype add-on now and for free

Atlassian Marketplace

...