A document type (doctype) defines the properties and section for document instances. It also provides home and index pages. In Confluence these doctypes are implemented as page blueprints, usually with one template. This template is used to create new pages in Confluence.

Short Name
Doctype
Relation

When information needs to be written down immediately two questions arise.

  1. Where do I put this new document?
  2. How do I structure the information in this document?

Authors should not need to think hard to answer these two questions. They should focus on the content, the information that needs to be published and be made available to stakeholders.

 

Naturally the structure of a document also supports to deliver the information. Therefore authors are allowed to change the structure to fit their needs.

The goal of document types is to provide a structure that fits most use cases and which may be good enough for the communication with stakeholders.

A document type (doctype) defines the properties and section for document instances. It also provides homepages and index pages. In Confluence these doctypes are implemented as page blueprints, usually with one single template. This template is used to create new pages in Confluence.

Specializations

Entity Document Type
Instances of this type provide information on an entity of the domain.
Organizing Document Type
Instances of this type organize documents by providing metadata.

Resources

Document Types and Templates
Document types (or doctypes for short) define a set of properties and sections. Each doctype matches at least one Confluence Page Blueprint. Confluence Page Blueprints are a collection of templates, but often the collection contains only one element.
Doctypes
Doctypes define properties and sections for documents. They are essentially Confluence Blueprints that help to create pages in your wiki based on templates.
Document Instance
A projectdoc document instance is based on a document type. Documents are created using page wizards provided by blueprints.

The projectdoc Toolbox provides a number of document types as separate doctype add-ons.

 

Some of the blueprints listed here are not yet publicly available. Please check the doctype add-ons for actual availability!


# Name Short Description Suite
1
Credentials for development systems where the password is known to all who have access to the Confluence wiki.
2
Type-specific category for access information.
3
This documents a possible option for a decision. Choose this document type to describe the alternative for a decision in more detail. This is typically a subpage of a decision document.
4
Group your alternatives by a self-defined type.
5
Announcements are a way to communicate an important piece of information with your team.
6
Describe your vision for one year. You plan will help you stay focussed to accomplish your goals.
7
Categories for annual visions.
8
Document your app for your users and customers.
9
Provide more detailed information about a component of a tool.
10
Document the purpose and usage of the components of this type.
11
Document your extension for your users and customers.
12
Document the purpose and usage of the extension of this type.
13
Applications provided functions required by services. Applications may be hosted on one or more systems.
14
Type-specific category for applications.
15
Document the purpose and usage of the macro.
16
Document the purpose and usage of the macros of this type.
17
A parameter is a configuration option. Parameter exist on different layers. Wizard and macro parameters are configuration options. Use
parameter types to organize them!
18
Document the purpose and usage of the app parameters of this type.
19
Document a platform for apps.
20
Document the purpose and usage of the platforms of this type.
21
Document a service provided by an app.
22
Document the purpose and usage of the app services of this type.
23
Document a tool provided by an app.
24
Document the purpose and usage of the app tools of this type.
25
Document the purpose and usage of the apps of this type.
26
The blueprint of the arc42 Template creates a tree of pages in the Confluence space.
27
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.
28
Group architecture alternatives by their type.
29
Document an aspect of your architecture. Something orthogonal or cross-functional like logging, exception handling or configurability.
30
Group architecture aspects by their type.
31
The second chapter of the arc42 Template with information on constraints and conventions.
32
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.
33
Architecture decisions are group by their types. A commonly used decision type is 'Architecture'.
34
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.
35
Artifact types categorize artifacts.
36
Explain an asset of your work. Add this document to a day in your diary.
37
Categories for assets.
38
Associates two documents.
39
Categorize associations by a type.
40
Document assumptions to assess risks and opportunities for the project.
41
Assumptions document what you think about your product, customers, and partners. Once you start identifying assumptions, it will become clearer what other beliefs you hold about how you plan to build, design, distribute, and create value with your product. Making assumptions explicit allows to publish them and discuss them with other stakeholders.
42
Assumptions can be resolved in different ways. Define what each resolution implies.
43
Type-specific category for assumption resolutions.
44
Type-specific category for assumptions.
45
Assumptions are grouped by their type.
46
Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.
47
Group blackboxes by their type.
48
The blank template simply provides a minimal integration with projectdoc features. It is a quick starting point to use projectdoc.
Native
49
The bookmarklets editor is a simple page that allows teams to create their bookmarklets more easily. It also provides access to some standard bookmarklets provided for the projectdoc Toolbox.
50
The fifth chapter of the arc42 Template with information on the local building blocks, and their dependencies and relationships.
51
Categories allow to set document instance of different doctypes in a hierarchy.
52
Categorize categories by a type.
53
Describes an information need and use this description as a basis to create and maintain a document.
54
Categorize charters by a type.
55
A brief solution to a problem.
56
Categories for cheats.
57
Document the result of a OKR check-in.
58
Type-specific category for OKR check-ins.
59
Checklists allow to run manual tasks in a defined manner. It guides the user of the checklist through a process and helping to not forget a step.
60
Categorize checklists by type.
61
Describe the codes that are part of the product's API.
62
Code types categorize codes, used in logging or exception handling.
63
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.
64
Component types categorize components.
65
Configuration items (CIs) may be (sub-)systems or components. Whatever may change and needs to be tracked may be documented as a CI.
66
Signals the status of an IT system, application, or a configuration item.
67
Type-specific category for configuration items.
68
The eighth chapter of the arc42 Template with conceptional information about the system.
69
Datasets are used as the input and output of processes.
70
Type-specific category for datasets.
71

Store relevant information discovered today in your developer diary.

72
Categories for days.
73
Document a 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.
74
Group your decisions by a self-defined type.
75
Deployments are requested and fulfilled. This instructs a member of the delivery team to provision an environment with a specific system.
76
Type-specific category for deployments.
77
The seventh chapter of the arc42 Template with information about how the system is deployed.
78
The ninth chapter of the arc42 Template that explains the architecture decisions that led to the system.
79
The homepage of a developer's daily diary pages. Consider to add your diary to your personal space!
80
Categories for diaries.
81
Document the usage of a doctype for your users.
82
Document the purpose and usage of the doctypes of this type.
83
Document the usage of a document property for your users.
84
Document the purpose and usage of the properties of this type.
85
Document the purpose and usage of the sections of this type.
86
Document the usage of a document section for your users.
87
Document logical or physical groups of nodes.
88
Type of an environment used by the project to deploy the application or the solution.
89
Associated an event with a day. A event is a collection of associated information for your later reference. Information may further be organized by subject, tags, categories, and audience.
90
Categories for events.
91
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.
92
Categorize excerpts by a type.
93
Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach.
94
Categorize experience levels by a type.
95
FAQs help to record an answer to a frequently asked question concerning the project, the product, the system or the process.
96
Categorize FAQs by a type.
97
Documents a feature of the product. The top features define the main aspects of the product.
98
Feature types categorize features.
99
Generic Documents provide information where no other doctype matches.
100
Categorize generic documents by a type.
101
The last chapter of the arc42 Template lists terms of the domain and explains them.
102
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.
103
Categorize glossary items by a type.
104
Describe how the impact will be pursued.
105
Type-specific category for hows.
106
Write your problem hypothesis. This is the hypothesis that you will either validate or (probably) come back and revise.
107
Type-specific category for hypotheses based on status.
108
Type-specific category for hypothesis status.
109
Type-specific category for hypotheses.
110
Publish an impact you want to achieve. Share this information with your colleagues.
111
Publish impacts you want to achieve. Share this information with your colleagues.
112
Type-specific category for impact maps.
113
Type-specific category for impacts.
114
Improvement proposals help to start the conversation within the team for process improvements.
115
Interfaces document how elements of the system communicate with elements of this and other systems.
116
Group interfaces by their type.
117
The first chapter of the arc42 Template with information on requirements, quality goals, and stakeholders.
118
IT Activities define activities for processes.
119
Type-specific category for IT activities.
120
IT Assets define assets required or produced by processes.
121
Type-specific category for IT assets.
122
Document an Iteration that may be linked from JIRA. Allows the team to set the goal and add notes relevant to a particular iteration.
123
Functions are specialized organizational units to support business processes.
124
Type-specific category for IT functions.
125
IT Procedures define procedures for processes.
126
Type-specific category for IT procedures.
127
Processes organize activities to create a defined business value.
128
Type-specific category for IT processes.
129
IT Services provide business relevant services for customers.
130
Classifiers to categorize services.
131
Type-specific classification for IT services.
132
Signals the status of an IT Service.
133
Type-specific category for IT services.
134
Systems are part of environments where products are deployed to.
135
Systems are categorized by their type. These types may be quite concrete since systems by nature reference a hard- or software system usually by their IP address or DNS name. Therefore a system type may be 'Artifact Repository' or 'Virtual Server. And types may build hierarchies.
136
Publish key results to achieve in order to pursue an objective to share with your colleagues.
137
Type-specific category for key results.
138
Add lifecycles to group lifecycle phases.
139
Lifecycle phases define phases that are bound to a lifecycle.
140
Locations provide information about the whereabouts of assets, configuration items, and systems.
141
Type-specific category for locations.
142
Resources are identified by their media type. This may be the MIME type, but also a human readable string, that identifies the syntactic format.
143
Categorize media types by their type.
144

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.

145
146
Record the action items of a meeting.
147
Group your minutes by a self-defined type.
148
Define a mission for your company or product.
149
Type-specific category for mission statements.
150
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.
151
Categorization of document modules for single sourcing.
152

Plan and run a retrospective for your month of work.

153
Categories for months.
154
Nodes are part of environments where artifacts are deployed to.
155
Node types categorize nodes.
156
Publish an objective to share with your colleagues.
157
Type-specific category for objectives.
158
Category to organize strategic themes, objectives, and key results.
159
Open issues document what the team needs to know to proceed.
160
Open issues are grouped by the severity of their impact on the project.
161
Open issues are grouped by the status.
162
Group your open issues by a self-defined type.
163
Document and track identified opportunities for the project.
164
Opportunities are grouped by their type.
165
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.
166
Categorize organizations by a type.
167
Products used by customers intend to make a change. This change is called outcome.
168
Type-specific category for outcomes.
169
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.
170
Out item types categorize out items.
171
The output is the artifact created to be employed by user for a specific outcome and - on the long run - may make an impact.
172
Type-specific category for outputs.
173
Document the purpose and usage of a page blueprint.
174
Document the purpose and usage of the page blueprints of this type.
175
Patterns provide solutions for problems in a given context. Patterns are usefull in multiple areas such as design, architecture, documentation, or process.
176
Patterns are divided into different domains to group patterns.
177
Categorize patterns by type.
178
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).
179
Categorize persons by a type.
180
Document problems as a means to communicate the details and to use the information for reviews and retrospections.
181
Problems are grouped by their type.
182
Impacts define how the results of processes affect the world.
183
Type-specific category for impacts.
184
Outcomes define the results of processes.
185
Type-specific category for outcomes.
186
Product Backlogs are means to collect user stories.
187
Profiles provide views on documents via delegation.
188
Categorize profiles by a type.
189
Project Constraints limit the options of a project.
190
Project constraint types categorize project constraints.
191
Project Rules are defined by the team to enhance the collaboration and to define project standards.
192
Categorize project rules by type.
193
Frame the vision for a project or iteration.
194
Types to categorize vision statements for projects.
195
Properties are part of the configuration options of a system.
196
Property types categorize properties of products, such as parameters or configuration options.
197
Qualities describe desired aspects of the product.
198
The tenth chapter of the arc42 Template that lists scenarios to systematically evaluate the architecture against the quality requirements.
199
Quality Scenarios document required qualities.
200
Quality scenario types categorize quality scenarios.
201
Documents a quality target for a product.
202
Group quality targets by their type.
203
Quotes relevant for the project. Allows to store the content and metadata to the quote.
204
Categorize quotes by a type.
205
Organizes glossary items.
206
Categorize relations by a type.
207
Document changes provided by a release of a product.
208
Group your release notes by a self-defined type.
209
Reports document what the team has decided or done. This is a generic document.
210
Group your reports by a self-defined type.
211
Documents requirements of a product.
212
Categorization of requirements for a product.
213
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.
214
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.
215
Record the discussion of the team about their last iteration.
216
Plan and run your review meeting.
217
A single act to show on the review. Use this only if you have a lot to show or you want to reference the review results later. Often a simple numerated list is sufficient.
218
Document and track identified risks for the project.
219
Document actions to prevent or reduce the negative impact on exceptions on a project.
220
Risk actions are grouped by their type.
221
Risks are grouped by the phase of their impact on the project.
222
Risks are grouped by the probability of having impact on the project.
223
The eleventh chapter of the arc42 Template lists risks and technical debt.
224
Risks are grouped by the severity of their impact on the project.
225
Document targets of risks.
226
Risk tagets are grouped by their type.
227
Risks are grouped by their type.
228
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.
229
Categorize roles by a type.
230
The sixth chapter of the arc42 Template with runtime information about the architecture.
231
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.
232
Categorize sections by a type.
233
Describe a service level for a service.
234
Provide information about a service level agreement (SLA).
235
Type-specific category for service level agreements.
236
Describe a requirement in terms of a service level.
237
Type-specific category for service level requirements.
238
Type-specific category for service levels.
239
The fourth chapter of the arc42 Template explains the solution idea.
240
Document the purpose and usage of a space blueprint.
241
Document the purpose and usage of the space blueprints of this type.
242
Compile other documents, yet space indices are themselves projectdoc documents. So they can be tagged and grouped.
243
Categorize space indexes by a type.
244
Space properties hold metadata of a space. They may be inherited by delegate spaces.
245
Document the purpose and usage of the space properties of this type.
246
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.
247
Categorize stakeholders by a type.
248
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.
249
Categorize steps by a type.
250
Publish a strategic theme to group objectives and to share them with your colleagues.
251
Type-specific category for strategic themes.
252
Defines a strategy for an organization or product.
253
Type-specific category for strategies.
254
Subject documents allow to set document instance of different doctypes in a common context.
255
Categorize subjects by a type.
256
Work on strengths, weaknesses, opportunities, and threats.
257
Type-specific category for SWOTs.
258
The third chapter of the arc42 Template with information on context and external interfaces.
259
Document the semantics of a tag. May also be used to document Confluence labels.
260
Categorize tags by a type.
261
Document processes defined and used by the team.
262
Categorize team processes by type.
263
Technical Debts track issues to be paid back.
264
Technical Debts are grouped by the area they address.
265
Document a test case of your project.
266
Test case types categorize test cases.
267
Defines a charter to run an exploratory test session.
268
Test charter types categorize test charters.
269
Document data used for test cases.
270
Test data types categorize test data.
271
Documents the results of a test session for the sponsoring stakeholders.
272
Test report types categorize test reports.
273
Defines a document to collect information during a test session.
274
Test session types categorize test sessions.
275
Add a todo note to your developer diary.
276
Categories for todos.
277
Document tools used by the team. Add information about how to fetch, install and best practices using it.
278
Categorize tools by type.
279
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.
280
A topic type is a semantic type of the topic. It helps to set the expectations of potential readers.
281
Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic.
282
Triggers define signals for activities and processes.
283
Type-specific category for triggers.
284
Defines a use case of the product.
285
Use case types categorize use cases.
286
User Characters are the actors of user stories. They include personas and extreme characters.
287
User character types categorize user characters.
288
User Stories document a requirement of a stakeholder with a specific business goal. It also provides an acceptance test. It is a representation of a unit of work.
289
Document a version of a product or service.
290
Categorize versions by a type.
291
Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.
292
Groups the views at a system.
293
Describe your vision for your career.
294
Define the vision for your organization or product.
295
Type-specific category for vision statements.
296
Categories for visions.
297

Plan and run a retrospective for your week of work.

298
Categories for weeks.
299
Describe the (high-level) deliverables (aka outcomes and outputs) required to achieve the impact.
300
Type-specific category for whats.
301
Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.
302
Group whiteboxes by their type.
303
Describe who is involved in the impact. List the stakeholders that will support the impact. There may be stakeholders who will work against it. Also specify the stakeholders taking advantage or taking disadvantage even if they do not have power to influence the outcome.
304
Type-specific category for whos.
305
Describe why this impact is useful for your business. State the problem to be solved.
306
Type-specific category for whys.
307
Work Instructions define procedures for processes. Provide the most detailed information here how tasks are to be executed. This includes best practices.
308
Type-specific category for work instructions.
309
Track what you have achieved and the reasons why. Check what you have learned and find areas where you can improve.
310
Type-specific category for OKR wrap-ups.
311
Create a year in your Diary.
312
Categories for years.