projectdoc Toolbox

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

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.

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

Tour for Document Authors
Tour through the documentation for users who want to learn to create documents based on projectdoc doctypes.
Software Project Documentation
How to start your software project documentation? Here are the steps to get started with Confluence and the projectdoc Toolbox.

# Name Short Description Set Documentation Type Categories
1
The blueprint of the arc42 Template creates a tree of pages in the Confluence space.
2
Document a possible option for an architecture decision. Choose this document type to describe the alternative for a decision in more detail. This is typically a subpage of an architecture decision document.
3
Document an aspect of your architecture. Something orthogonal or cross-functional like logging, exception handling or configurability.
4
Document a architecture decision for an option. This is useful to state the reasons and the options that have been evaluated. Later other team members will have it easier to understand the decision.
5
Architecture decisions are group by their types. A commonly used decision type is 'Architecture'.
6
Document requirements you impose on artifacts. Artifacts are created by processes defined and used by the team. This includes assemblies created by the build process, source code artifacts or reports.
7
Artifact types categorize artifacts.
8
Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.
9
Describe the codes that are part of the product's API.
10
Code types categorize codes, used in logging or exception handling.
11
Components are part of a view on a system. A component may refer to a enclosed element or to a complete system of its own.
12
Component types categorize components.
13
Document logical or physical groups of nodes.
14
Type of an environment used by the project to deploy the application or the solution.
15
Documents a feature of the product. The top features define the main aspects of the product.
16
Feature types categorize features.
17
Interfaces document how elements of the system communicate with elements of this and other systems.
18
Nodes are part of environments where artifacts are deployed to.
19
Node types categorize nodes.
20
Out Items record topics that are out of the scope of the project. This is useful for project inception and for reference in the future.
21
Out item types categorize out items.
22
Project Constraints limit the options of a project.
23
Project constraint types categorize project constraints.
24
Properties are part of the configuration options of a system.
25
Property types categorize properties of products, such as parameters or configuration options.
26
Qualities describe desired aspects of the product.
27
Quality Scenarios document required qualities.
28
Quality scenario types categorize quality scenarios.
29
Documents a quality target for a product.
30
Documents requirements of a product.
31
Categorization of requirements for a product.
32
Technical Debts track issues to be paid back.
33
Technical Debts are grouped by the area they address.
34
Document a test case of your project.
35
Test case types categorize test cases.
36
Defines a charter to run an exploratory test session.
37
Test charter types categorize test charters.
38
Document data used for test cases.
39
Test data types categorize test data.
40
Documents the results of a test session for the sponsoring stakeholders.
41
Test report types categorize test reports.
42
Defines a document to collect information during a test session.
43
Test session types categorize test sessions.
44
Defines a use case of the product.
45
Use case types categorize use cases.
46
User Characters are the actors of user stories. They include personas and extreme characters.
47
User character types categorize user characters.
48
Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.
49
Groups the views at a system.
50
Frame the vision for a project or iteration.
51
Vision statement types categorize vision statements.
52
Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.

Related Macros

The following macros are provided by this add-on.

User Story Macro
Renders a user story of a user story doctype.

Resources

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