List of all Topics

List of all topics relevant to agile documentation.

projectdoc Introduction

A short introduction into the concepts and features of the projectdoc Toolbox.

Index Space

Index spaces provide basic configuration via space properties and homepages for commonly used document types.

Space Properties in Index Space

Space properties that need to be seen by all spaces are defined in the index space.

Address Book

Organize information about persons and organizations.

Common generic Types

Index spaces also define generic types that are used by all doctypes.

Library Space

A library space holds resources in a separate repository.

Default Homepages

Document type homepages in the index space serve as automatic homepages if the current space lacks a homepage for that document type.

Glossary Space

Attachment space for defining or describing terms of one or more domains.

Team Space

A sample space for the collaboration of an agile team.

Learning Center

A sample space for tracking skills of members of an organization.

Value

What is value in the context of technical and team communication?

Values

Values represent characteristics or qualities of documentation that are important to readers, writers, and sponsors.

Principles

List of principles for agile documentation (mostly) derived from software development principles.

Qualities of Documentation

In the context of documentation or team communication there are a lot of values.

Practices

Practices to collaborate on agile documentation.

Qualities for Readers

Readers of documentation value these qualities.

projectdoc

The projectdoc Toolbox is an add-on for Confluence supporting agile teams to collaborate on agile documentation.

Qualities for Writers

While writers value the same qualities readers do, they also extend their expectations on qualities for writing documentation.

Qualities for Sponsors

Sponsors take an interest in documentation while they are neiter involved in the creation and maintenance processes nor are necessarily part of the documentation's audience.

Create a Project Glossary

A step-by-step guide to create a glossary with the projectdoc Toolbox.

Documentation Quadrants

A view on documentation to locate types of documents.

Show Cases

A set of Confluence spaces showing projectdoc in action.

Teamwork to create a Paper

To investigate on a topic or to create a positioning paper collaboratively with a team, a workspace is a handy tool. Information is collected and arranged and the results may be exported to a PDF to be send to interested stakeholders.

Use Cases

An overview over the use cases for which the projectdoc Toolbox provides support.