- Created by Robert Reiner, last modified on 03. Nov 2022
projectdoc Toolbox
Provides a basic set of doctypes to create agile documentation.
The core doctypes provide the base for your agile documentation work with the projectdoc Toolbox for Confluence. You may also use them as an inspiration for designing your own templates that meet exactly the requirements of your project.
Please refer to Tour for Document Authors for an introduction on how to use these templates and to Tour for Template Authors for information on how to design your own templates.
You may also take an alternative introduction to the Core Doctypes by a Prezi presentation. The presentation provides a good overview by grouping closely related doctypes.
Create a Space
To get started with the Core Doctypes, we recommend to create an Core Project Space.
This provides the basic structure to add new documents easily by the use of home and index pages. This is how the space looks like:
If you prefer to start with a relatively blank space, consider to choose the Configuration Space. It creates a home page and an index page for type documents.
List of Space Blueprints
The following space blueprints are provided by the Core Doctypes.
- Address Book
Manage information about people and their roles and interests in a product or project. This space contains information about roles, persons, and organizations.
- Configuration Space
Manage commonly used configurations without any subdocuments (besides a homepage for type homepages).
- Core Project Space
Create a space to organize information for your agile team. A basic structure with homepages is created, such as for tags, topics, or roles).
- Glossary
Manage information about a domain. Add glossary items and associate them with domain information.
- Index Space
Collect commonly used information like spaces properties or type documents. You may also include fragments to be used by transclusion or other information that is relevant for all dependent spaces.
- Library
Manage information about resources. This includes books, articles, podcasts, as well as information about the authors of these resources.
- Topic Space
- Create a space to collect and organize information on a topic.
- Workspace
Create a space to collaboratively collect information on a specific topic. A workspace does not demand for updating information. It is a place to work with until a goal is reached. Move the result of your research to topic spaces and discard or archive this space.
List of Doctypes
The doctypes provided by Core Doctypes are very basic and sometimes generic. Note that there are additional doctype add-ons that support the documentation of more specific domains. The doctypes provided by Core Doctypes are often also used in these domains, for instances roles or tags.
The following doctypes help to organize core project or product information.
| # | Name | Short Description | Documentation Type | Categories |
|---|---|---|---|---|
| 1 | Association | Associates two documents. | / Document / Part | |
| 2 | Association Type | Categorize associations by a type. | Q1 - Process | / Organisation / Specific |
| 3 | Category | Categories allow to set document instance of different doctypes in a hierarchy. | Q1 - Process | / Organisation / Generic |
| 4 | Category Type | Categorize categories by a type. | Q1 - Process | / Organisation / Specific |
| 5 | Charter | Describes an information need and use this description as a basis to create and maintain a document. | Q2 - Project | / Work / Unit |
| 6 | Charter Type | Categorize charters by a type. | Q1 - Process | / Organisation / Specific |
| 7 | Excerpt | Excerpts are abstracts of information found in a resource, such as a book. If you want to go into more detail for a given resource, there may be multiple excerpts as subpages of the resource document. | / Document / Part | |
| 8 | Excerpt Type | Categorize excerpts by a type. | Q1 - Process | / Organisation / Specific |
| 9 | Experience Level | Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach. | Q1 - Process | / Organisation / Specific |
| 10 | Experience Level Type | Categorize experience levels by a type. | Q1 - Process | / Organisation / Specific |
| 11 | FAQ | FAQs help to record an answer to a frequently asked question concerning the project, the product, the system or the process. | Documentation | |
| 12 | FAQ Type | Categorize FAQs by a type. | Q1 - Process | / Organisation / Specific |
| 13 | Generic | Generic Documents provide information where no other doctype matches. | / Document / Entity | |
| 14 | Generic Type | Categorize generic documents by a type. | Q1 - Process | / Organisation / Specific |
| 15 | Glossary Item | Glossary items are part of the domain glossary for the project. Glossaries support the team to use terms of the domain consistently in conversations and documentation. | Q1 - Process | / Document / Entity |
| 16 | Glossary Item Type | Categorize glossary items by a type. | Q1 - Process | / Organisation / Specific |
| 17 | Media Type | Resources are identified by their media type. This may be the MIME type, but also a human readable string, that identifies the syntactic format. | Q1 - Process | / Organisation / Specific |
| 18 | Media Type Type | Categorize media types by their type. | Q1 - Process | / Organisation / Specific |
| 19 | Metadata | Metadata documents provide tables of simple key/value pairs. This information can be used as an aspect or as additional space properties to be available for reference on your wiki. | / Document / Data | |
| 20 | Metadata Type | Categorize metadata documents by a type. | Q1 - Process | / Organisation / Specific |
| 21 | Module | 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. | / Document / Entity | |
| 22 | Module Type | Categorization of document modules for single sourcing. | Q1 - Process | / Organisation / Specific |
| 23 | Organization | Information about organizations that take a part in the project. You may collect common information here for all persons that belong to an organization, such as address or homepage. | Q2 - Project | / Team |
| 24 | Organization Type | Categorize organizations by a type. | Q1 - Process | / Organisation / Specific |
| 25 | Person | Provides information about a person. This includes contact information (important if the person is relevant for the team) or information about the competences (if the person is an author about a topic relevant for the project). | Q2 - Project | / Team |
| 26 | Person Type | Categorize persons by a type. | Q1 - Process | / Organisation / Specific |
| 27 | Profile | Profiles provide views on documents via delegation. | / Document / Part | |
| 28 | Profile Type | Categorize profiles by a type. | Q1 - Process | / Organisation / Specific |
| 29 | Quote | Quotes relevant for the project. Allows to store the content and metadata to the quote. | Q1 - Process | / Document / Entity |
| 30 | Quote Type | Categorize quotes by a type. | Q1 - Process | / Organisation / Specific |
| 31 | Relation | Organizes glossary items. | Q1 - Process | / Organisation / Specific |
| 32 | Relation Type | Categorize relations by a type. | Q1 - Process | / Organisation / Specific |
| 33 | Resource | Resources are books, webpages, videocasts relevant for the project. Add important information to your project about resources that lie outside the control of your team. | Q1 - Process | / Document / Entity |
| 34 | Resource Type | Resources are identified by their type. This is not the MIME type, but human readable string, that identifies the semantic, rather than the syntactic format. | Q1 - Process | / Organisation / Specific |
| 35 | Role | 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. | Q1 - Process | / Organisation / Generic |
| 36 | Role Type | Categorize roles by a type. | Q1 - Process | / Organisation / Specific |
| 37 | Section | 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. | / Document / Part | |
| 38 | Section Type | Categorize sections by a type. | Q1 - Process | / Organisation / Specific |
| 39 | Space Index | Compile other documents, yet space indices are themselves projectdoc documents. So they can be tagged and grouped. | / Organisation / Space | |
| 40 | Space Index Type | Categorize space indexes by a type. | Q1 - Process | / Organisation / Specific |
| 41 | Stakeholder | A party that takes interest in a project. The stakeholder is either a real person, an organization or group, or represents a class of individuals, groups or organizations. | Q2 - Project | / Team |
| 42 | Stakeholder Type | Categorize stakeholders by a type. | Q1 - Process | / Organisation / Specific |
| 43 | Step | Describes a single step of an activity. A step is a generic document that is associated with a document that describes a process. It may be a test log or a howto. | / Document / Part | |
| 44 | Step Type | Categorize steps by a type. | Q1 - Process | / Organisation / Specific |
| 45 | Subject | Subject documents allow to set document instance of different doctypes in a common context. | Q1 - Process | / Organisation / Generic |
| 46 | Subject Type | Categorize subjects by a type. | Q1 - Process | / Organisation / Specific |
| 47 | Tag | Document the semantics of a tag. May also be used to document Confluence labels. | Q1 - Process | / Organisation / Generic |
| 48 | Tag Type | Categorize tags by a type. | Q1 - Process | / Organisation / Specific |
| 49 | Topic | 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. | / Document / Entity | |
| 50 | Topic Type | A topic type is a semantic type of the topic. It helps to set the expectations of potential readers. | Q1 - Process | / Organisation / Specific |
| 51 | Tour | Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic. | / Document / Aggregate | |
| 52 | Version | Document a version of a product or service. | / Document / Data | |
| 53 | Version Type | Categorize versions by a type. | Q1 - Process | / Organisation / Specific |
Resources
Related information to work with Core Doctypes.
- Doctypes
- More information on doctypes for the projectdoc Toolbox.
- Extension Doctypes
- List of additional doctypes provided by free add-ons for specific domains.
- Macros
- List of macros from the projectdoc Toolbox to be used in your Confluence blueprints (2013).
- projectdoc Document
- projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.
