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.
Doctypes Overview
List of all doctypes provided by add-ons. Provides an overview over doctype IDs and blueprint keys.

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
Document a single change to configuration items or assets.
54

Add an severity to classify changes.

55

Add a status to categorize changes.

56

Add a theme to group changes.

57

Type-specific category for changes.

58
Describes an information need and use this description as a basis to create and maintain a document.
59
Categorize charters by a type.
60

A brief solution to a problem.

61

Categories for cheats.

62

Document the result of a OKR check-in.

63

Type-specific category for OKR check-ins.

64
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.
65
Categorize checklists by type.
66
Describe the codes that are part of the product's API.
67
Code types categorize codes, used in logging or exception handling.
68
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.
69
Component types categorize components.
70
Configuration items (CIs) may be (sub-)systems or components. Whatever may change and needs to be tracked may be documented as a CI.
71

Signals the status of an IT system, application, or a configuration item.

72

Type-specific category for configuration items.

73
The eighth chapter of the arc42 Template with conceptional information about the system.
74

Add cycles to group cycle phases.

75

Cycle phases define phases that are bound to a cycle, such as lifecycles or iterations.

76

Datasets are used as the input and output of processes.

77

Type-specific category for datasets.

78
Document a data type for properties and codes.
79
Data type types categorize data types.
80

Store relevant information discovered today in your developer diary.

81

Categories for days.

82
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.
83
Group your decisions by a self-defined type.
84
Deployments provide information about updates on services and systems to users.
85
Record a deployment to a IT system.
86

Type-specific category for deployment records.

87

Type-specific category for deployments.

88
The seventh chapter of the arc42 Template with information about how the system is deployed.
89
The ninth chapter of the arc42 Template that explains the architecture decisions that led to the system.
90
The homepage of a developer's daily diary pages. Consider to add your diary to your personal space!
91

Categories for diaries.

92
Document the usage of a doctype for your users.
93

Document the purpose and usage of the doctypes of this type.

94
Document the usage of a document property for your users.
95

Document the purpose and usage of the properties of this type.

96

Document the purpose and usage of the sections of this type.

97
Document the usage of a document section for your users.
98
Document logical or physical groups of nodes.
99
Type of an environment used by the project to deploy the application or the solution.
100
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.
101

Categories for events.

102
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.
103
Categorize excerpts by a type.
104
Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach.
105
Categorize experience levels by a type.
106
FAQs help to record an answer to a frequently asked question concerning the project, the product, the system or the process.
107
Categorize FAQs by a type.
108
Documents a feature of the product. The top features define the main aspects of the product.
109
Feature types categorize features.
110
Generic Documents provide information where no other doctype matches.
111
Categorize generic documents by a type.
112
The last chapter of the arc42 Template lists terms of the domain and explains them.
113
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.
114
Categorize glossary items by a type.
115

Describe how the impact will be pursued.

116

Type-specific category for hows.

117

Write your problem hypothesis. This is the hypothesis that you will either validate or (probably) come back and revise.

118

Type-specific category for hypotheses based on status.

119

Type-specific category for hypothesis status.

120

Type-specific category for hypotheses.

121

Publish an impact you want to achieve. Share this information with your colleagues.

122

Publish impacts you want to achieve. Share this information with your colleagues.

123

Type-specific category for impact maps.

124

Type-specific category for impacts.

125
Improvement proposals help to start the conversation within the team for process improvements.
126
Interfaces document how elements of the system communicate with elements of this and other systems.
127
Group interfaces by their type.
128
The first chapter of the arc42 Template with information on requirements, quality goals, and stakeholders.
129
IT Activities define activities for processes.
130

Type-specific category for IT activities.

131
IT Assets define assets required or produced by processes.
132
Type-specific category for IT assets.
133
Document an Iteration that may be linked from JIRA. Allows the team to set the goal and add notes relevant to a particular iteration.
134
Functions are specialized organizational units to support business processes.
135

Type-specific category for IT functions.

136

IT Procedures define procedures for processes.

137

Type-specific category for IT procedures.

138
Processes organize activities to create a defined business value.
139

Type-specific category for IT processes.

140
IT Services provide business relevant services for customers.
141

Classifiers to categorize services.

142

Type-specific classification for IT services.

143

Signals the status of an IT Service.

144

Type-specific category for IT services.

145
Systems are part of environments where products are deployed to.
146
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.
147

Publish key results to achieve in order to pursue an objective to share with your colleagues.

148

Type-specific category for key results.

149

Add lifecycles to group lifecycle phases.

150

Lifecycle phases define phases that are bound to a lifecycle.

151

Locations provide information about the whereabouts of assets, configuration items, and systems.

152

Type-specific category for locations.

153
Resources are identified by their media type. This may be the MIME type, but also a human readable string, that identifies the syntactic format.
154
Categorize media types by their type.
155

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.

156
157
Record the action items of a meeting.
158
Group your minutes by a self-defined type.
159
Define a mission for your company or product.
160

Type-specific category for mission statements.

161
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.
162
Categorization of document modules for single sourcing.
163

Plan and run a retrospective for your month of work.

164

Categories for months.

165
Nodes are part of environments where artifacts are deployed to.
166
Node types categorize nodes.
167
Publish an objective to share with your colleagues.
168

Type-specific category for objectives.

169

Category to organize strategic themes, objectives, and key results.

170
Open issues document what the team needs to know to proceed.
171
Open issues are grouped by the severity of their impact on the project.
172
Open issues are grouped by the status.
173
Group your open issues by a self-defined type.
174
Document and track identified opportunities for the project.
175
Opportunities are grouped by their type.
176
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.
177
Categorize organizations by a type.
178

Products used by customers intend to make a change. This change is called outcome.

179

Type-specific category for outcomes.

180
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.
181
Out item types categorize out items.
182

The output is the artifact created to be employed by user for a specific outcome and - on the long run - may make an impact.

183

Type-specific category for outputs.

184
Document the purpose and usage of a page blueprint.
185

Document the purpose and usage of the page blueprints of this type.

186
Patterns provide solutions for problems in a given context. Patterns are usefull in multiple areas such as design, architecture, documentation, or process.
187
Patterns are divided into different domains to group patterns.
188
Categorize patterns by type.
189
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).
190
Categorize persons by a type.
191
Document problems as a means to communicate the details and to use the information for reviews and retrospections.
192
Problems are grouped by their type.
193

Impacts define how the results of processes affect the world.

194

Type-specific category for impacts.

195

Outcomes define the results of processes.

196

Type-specific category for outcomes.

197
Product Backlogs are means to collect user stories.
198
Profiles provide views on documents via delegation.
199
Categorize profiles by a type.
200
Project Constraints limit the options of a project.
201
Project constraint types categorize project constraints.
202
Project Rules are defined by the team to enhance the collaboration and to define project standards.
203
Categorize project rules by type.
204
Frame the vision for a project or iteration.
205
Types to categorize vision statements for projects.
206
Properties are part of the configuration options of a system.
207
Property types categorize properties of products, such as parameters or configuration options.
208
Qualities describe desired aspects of the product.
209
The tenth chapter of the arc42 Template that lists scenarios to systematically evaluate the architecture against the quality requirements.
210
Quality Scenarios document required qualities.
211
Quality scenario types categorize quality scenarios.
212
Documents a quality target for a product.
213
Group quality targets by their type.
214
Quotes relevant for the project. Allows to store the content and metadata to the quote.
215
Categorize quotes by a type.
216
Organizes glossary items.
217
Categorize relations by a type.
218
Releases document the changes that are applied to a published version of a service.
219
Document changes provided by a release of a product.
220
Group your release notes by a self-defined type.
221
Type-specific category for releases.
222
Reports document what the team has decided or done. This is a generic document.
223
Group your reports by a self-defined type.
224
Documents requirements of a product.
225
Categorization of requirements for a product.
226
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.
227
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.
228
Record the discussion of the team about their last iteration.
229
Plan and run your review meeting.
230
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.
231
Document and track identified risks for the project.
232
Document actions to prevent or reduce the negative impact on exceptions on a project.
233
Risk actions are grouped by their type.
234
Risks are grouped by the phase of their impact on the project.
235
Risks are grouped by the probability of having impact on the project.
236
The eleventh chapter of the arc42 Template lists risks and technical debt.
237
Risks are grouped by the severity of their impact on the project.
238
Document targets of risks.
239
Risk tagets are grouped by their type.
240
Risks are grouped by their type.
241
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.
242
Categorize roles by a type.
243
The sixth chapter of the arc42 Template with runtime information about the architecture.
244
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.
245
Categorize sections by a type.
246

Announcements communicate with stakeholders information about a service.

247

Type-specific category for service announcements.

248
Describe a service level for a service.
249
Provide information about a service level agreement (SLA).
250

Type-specific category for service level agreements.

251
Describe a requirement in terms of a service level.
252
Type-specific category for service level requirements.
253

Type-specific category for service levels.

254
The fourth chapter of the arc42 Template explains the solution idea.
255
Document the purpose and usage of a space blueprint.
256

Document the purpose and usage of the space blueprints of this type.

257
Compile other documents, yet space indices are themselves projectdoc documents. So they can be tagged and grouped.
258
Categorize space indexes by a type.
259
Space properties hold metadata of a space. They may be inherited by delegate spaces.
260

Document the purpose and usage of the space properties of this type.

261
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.
262
Categorize stakeholders by a type.
263
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.
264
Categorize steps by a type.
265

Publish a strategic theme to group objectives and to share them with your colleagues.

266

Type-specific category for strategic themes.

267
Defines a strategy for an organization or product.
268

Type-specific category for strategies.

269
Subject documents allow to set document instance of different doctypes in a common context.
270
Categorize subjects by a type.
271
Work on strengths, weaknesses, opportunities, and threats.
272

Type-specific category for SWOTs.

273
The third chapter of the arc42 Template with information on context and external interfaces.
274
Document the semantics of a tag. May also be used to document Confluence labels.
275
Categorize tags by a type.
276
Document processes defined and used by the team.
277
Categorize team processes by type.
278
Technical Debts track issues to be paid back.
279
Technical Debts are grouped by the area they address.
280
Document a test case of your project.
281
Test case types categorize test cases.
282
Defines a charter to run an exploratory test session.
283
Test charter types categorize test charters.
284
Document data used for test cases.
285
Test data types categorize test data.
286
Documents the results of a test session for the sponsoring stakeholders.
287
Test report types categorize test reports.
288
Defines a document to collect information during a test session.
289
Test session types categorize test sessions.
290

Add a todo note to your developer diary.

291

Categories for todos.

292
Document tools used by the team. Add information about how to fetch, install and best practices using it.
293
Categorize tools by type.
294
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.
295
A topic type is a semantic type of the topic. It helps to set the expectations of potential readers.
296
Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic.
297

Triggers define signals for activities and processes.

298

Type-specific category for triggers.

299
Defines a use case of the product.
300
Use case types categorize use cases.
301
User Characters are the actors of user stories. They include personas and extreme characters.
302
User character types categorize user characters.
303
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.
304
Document a version of a product or service.
305
Categorize versions by a type.
306
Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.
307
Groups the views at a system.
308

Describe your vision for your career.

309
Define the vision for your organization or product.
310

Type-specific category for vision statements.

311

Categories for visions.

312

Plan and run a retrospective for your week of work.

313

Categories for weeks.

314

Describe the (high-level) deliverables (aka outcomes and outputs) required to achieve the impact.

315

Type-specific category for whats.

316
Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.
317
Group whiteboxes by their type.
318

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.

319

Type-specific category for whos.

320

Describe why this impact is useful for your business. State the problem to be solved.

321

Type-specific category for whys.

322
Work Instructions define procedures for processes. Provide the most detailed information here how tasks are to be executed. This includes best practices.
323
Type-specific category for work instructions.
324

Track what you have achieved and the reasons why. Check what you have learned and find areas where you can improve.

325

Type-specific category for OKR wrap-ups.

326

Create a year in your Diary.

327

Categories for years.