- Created by Robert Reiner, last modified on 07. Jan 2020
Collaborate to create documents for your stakeholders as a team.
- Categories
Confluence is a team collaboration platform. The projectdoc Toolbox support teams to write documentation in a modular style. Having separate documents for topics makes it even easier to work on a subject collaboratively. Team members edit different documents concurrently and assemble them by using transclusion or reference.
To create a discussion or positioning paper a team starts by defining the fundamental structure of the document in a new space. For each topic to be covered the team adds a section document as child to the root document. Information fragments that are included at different locations of the document are defined as modules. The individual documents (or parts of these documents) are assembled into a single document by transclusion. The team works collaboratively and concurrently on the separate documents. The current state of the compiled document is available instantly for everyone on the team and stakeholders with the appropriate access privileges.
Once the document is finished, it is printed to Microsoft Word format with ScrollOffice and exported to PDF. Both document formats are attached to the root document. If the team wants to provide a document that shows the changes to the external readers, the changes document is created on the current Word version and its predecessor.
The PDF version of the document is then sent to the external recipients. The team may want to track which stakeholders have received a copy of the document.
Resources
Information Material
The following list of resources provides background information on doing paperwork based on the projectdoc Toolbox for Confluence.
| Resource | Short Description | Type |
|---|---|---|
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. | topic | |
Get started with the projectdoc Toolbox: learning by doing | topic | |
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc. | topic |
Doctypes
The following doctypes (blueprints based on the projectdoc Toolbox) provided page blueprints to do paperwork.
| Resource | Short Description | Categories |
|---|---|---|
A description of a given topic. A topic may describing or explaining a concept, a task to accomplish or a reference. There are a couple of topic types that set the expectations for the reader. Instances of the topic doctype usually have independent lifetimes from any referencing documents. | ||
Sections of a document are typically part of a document. But the size of sections may vary. To support a team to write collaboratively on the documentation, a larger document may be subdivided into external section documents. | ||
A documentation module is a fragment which is usually transcluded by other documents. The lifetime of a module document is independent of the lifetimes of the documents that reference it. | ||
Describes an information need and use this description as a basis to create and maintain a document. | ||
Defines a role with its responsibilities, tasks and requirements. Roles are incorporated by stakeholders who take interest in the project. The are also used to define the audience for documents. |
Macros
The following macros of the projectdoc Toolbox support doing paperwork
| Resource | Short Description | Categories |
|---|---|---|
Sections of a document are typically part of a document. But the size of sections may vary. To support a team to write collaboratively on the documentation, a larger document may be subdivided into external section documents. | ||
Marks a piece of content within a document. This content can be referenced for transclusion. | ||
Transcludes content from a document marked with the content marker macro. | ||
Renders transcluded content fetched from documents of a result set. | ||
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided. | ||
Renders a predefined list of documents in a table. | ||
Renders a box containing a pending message to be handled later by the author. | ||
Renders a box containing a feedback message from a reader with write privilege. | ||
Renders a box containing a fault message reported by a team member for the author. | ||
Renders document history information. |
