Doctypes Overview

List of all doctypes provided by add-ons. Provides an overview over doctype IDs and blueprint keys.

Type

The list of doctypes available for projectdoc on this site.

# Name ID Set Short Description
1
access-information
Credentials for development systems where the password is known to all who have access to the Confluence wiki.
2
access-information-type

Type-specific category for access information.

3
alternative
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
alternative-type
Group your alternatives by a self-defined type.
5
announcement
Announcements are a way to communicate an important piece of information with your team.
6
annual-vision

Describe your vision for one year. You plan will help you stay focussed to accomplish your goals.

7
annual-vision-type

Categories for annual visions.

8
app
Document your app for your users and customers.
9
app-component
Provide more detailed information about a component of a tool.
10
app-component-type

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

11
app-extension
Document your extension for your users and customers.
12
app-extension-type

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

13
application
Applications provided functions required by services. Applications may be hosted on one or more systems.
14
application-type

Type-specific category for applications.

15
app-macro
Document the purpose and usage of the macro.
16
app-macro-type

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

17
app-parameter

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
app-parameter-type

Document the purpose and usage of the app parameters of this type.

19
app-platform
Document a platform for apps.
20
app-platform-type

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

21
app-service
Document a service provided by an app.
22
app-service-type

Document the purpose and usage of the app services of this type.

23
app-tool
Document a tool provided by an app.
24
app-tool-type

Document the purpose and usage of the app tools of this type.

25
app-type

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

26
swad
The blueprint of the arc42 Template creates a tree of pages in the Confluence space.
27
architecture-alternative
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
architecture-alternative-type
Group architecture alternatives by their type.
29
architecture-aspect
Document an aspect of your architecture. Something orthogonal or cross-functional like logging, exception handling or configurability.
30
architecture-aspect-type
Group architecture aspects by their type.
31
architecture-decision
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.
32
architecture-decision-type
Architecture decisions are group by their types. A commonly used decision type is 'Architecture'.
33
artifact
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.
34
artifact-type
Artifact types categorize artifacts.
35
asset
Explain an asset of your work. Add this document to a day in your diary.
36
asset-type

Categories for assets.

37
association
Associates two documents.
38
association-type
Categorize associations by a type.
39
assumption
Document assumptions to assess risks and opportunities for the project.
40
assumption-type
Assumptions are grouped by their type.
41
blackbox
Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.
42
blackbox-type
Group blackboxes by their type.
43
blank
Native
The blank template simply provides a minimal integration with projectdoc features. It is a quick starting point to use projectdoc.
44
bookmarklet-editor
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.
45
category
Categories allow to set document instance of different doctypes in a hierarchy.
46
category-type
Categorize categories by a type.
47
change
Document a single change to configuration items or assets.
48
change-severity

Add an severity to classify changes.

49
change-status

Add a status to categorize changes.

50
change-theme

Add a theme to group changes.

51
change-type

Type-specific category for changes.

52
charter
Describes an information need and use this description as a basis to create and maintain a document.
53
charter-type
Categorize charters by a type.
54
cheat

A brief solution to a problem.

55
cheat-type

Categories for cheats.

56
checklist
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.
57
checklist-type
Categorize checklists by type.
58
code
Describe the codes that are part of the product's API.
59
code-type
Code types categorize codes, used in logging or exception handling.
60
component
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.
61
component-type
Component types categorize components.
62
configuration-item
Configuration items (CIs) may be (sub-)systems or components. Whatever may change and needs to be tracked may be documented as a CI.
63
configuration-item-status

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

64
configuration-item-type

Type-specific category for configuration items.

65
cycle

Add cycles to group cycle phases.

66
cycle-phase

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

67
dataset

Datasets are used as the input and output of processes.

68
dataset-type

Type-specific category for datasets.

69
datatype
Document a data type for properties and codes.
70
datattype-type
Data type types categorize data types.
71
day

Store relevant information discovered today in your developer diary.

72
day-type

Categories for days.

73
decision
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
decision-type
Group your decisions by a self-defined type.
75
deployment
Deployments provide information about updates on services and systems to users.
76
deployment-record
Record a deployment to a IT system.
77
change-type

Type-specific category for deployment records.

78
deployment-type

Type-specific category for deployments.

79
diary
The homepage of a developer's daily diary pages. Consider to add your diary to your personal space!
80
diary-type

Categories for diaries.

81
doctype
Document the usage of a doctype for your users.
82
app-doctype-type

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

83
document-property
Document the usage of a document property for your users.
84
document-property-type

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

85
document-section
Document the usage of a document section for your users.
86
document-section-type

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

87
environment
Document logical or physical groups of nodes.
88
environment-type
Type of an environment used by the project to deploy the application or the solution.
89
event
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
event-type

Categories for events.

91
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.
92
excerpt-type
Categorize excerpts by a type.
93
experience-level
Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach.
94
experience-level-type
Categorize experience levels by a type.
95
faq
FAQs help to record an answer to a frequently asked question concerning the project, the product, the system or the process.
96
faq-type
Categorize FAQs by a type.
97
feature
Documents a feature of the product. The top features define the main aspects of the product.
98
feature-type
Feature types categorize features.
99
generic
Generic Documents provide information where no other doctype matches.
100
generic-type
Categorize generic documents by a type.
101
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.
102
glossary-item-type
Categorize glossary items by a type.
103
improvement
Improvement proposals help to start the conversation within the team for process improvements.
104
interface
Interfaces document how elements of the system communicate with elements of this and other systems.
105
interface-type
Group interfaces by their type.
106
it-activity
IT Activities define activities for processes.
107
it-activity-type

Type-specific category for IT activities.

108
it-asset
IT Assets define assets required or produced by processes.
109
it-asset-type
Type-specific category for IT assets.
110
iteration
Document an Iteration that may be linked from JIRA. Allows the team to set the goal and add notes relevant to a particular iteration.
111
it-function
Functions are specialized organizational units to support business processes.
112
it-function-type

Type-specific category for IT functions.

113
it-procedure

IT Procedures define procedures for processes.

114
it-procedure-type

Type-specific category for IT procedures.

115
it-process
Processes organize activities to create a defined business value.
116
it-process-type

Type-specific category for IT processes.

117
it-service
IT Services provide business relevant services for customers.
118
it-service-classification

Classifiers to categorize services.

119
it-service-classification-type

Type-specific classification for IT services.

120
it-service-status

Signals the status of an IT Service.

121
it-service-type

Type-specific category for IT services.

122
it-system
Systems are part of environments where products are deployed to.
123
it-system-type
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.
124
lifecycle

Add lifecycles to group lifecycle phases.

125
lifecycle-phase

Lifecycle phases define phases that are bound to a lifecycle.

126
location

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

127
location-type

Type-specific category for locations.

128
mediatype
Resources are identified by their media type. This may be the MIME type, but also a human readable string, that identifies the syntactic format.
129
mediatype-type
Categorize media types by their type.
130

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.

131
132
minutes
Record the action items of a meeting.
133
minutes-type
Group your minutes by a self-defined type.
134
mission-statement
Define a mission for your company or product.
135
mission-statement-type

Type-specific category for mission statements.

136
docmodule
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.
137
module-type
Categorization of document modules for single sourcing.
138
month

Plan and run a retrospective for your month of work.

139
month-type

Categories for months.

140

node

Nodes are part of environments where artifacts are deployed to.
141

node-type

Node types categorize nodes.
142
open-issue
Open issues document what the team needs to know to proceed.
143
open-issue-severity
Open issues are grouped by the severity of their impact on the project.
144
open-issue-status
Open issues are grouped by the status.
145
open-issue-type
Group your open issues by a self-defined type.
146
opportunity
Document and track identified opportunities for the project.
147
opportunity-type
Opportunities are grouped by their type.
148
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.
149
organization-type
Categorize organizations by a type.
150
out-item
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.
151
out-item-type
Out item types categorize out items.
152
page-blueprint
Document the purpose and usage of a page blueprint.
153
page-blueprint-type

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

154
pattern
Patterns provide solutions for problems in a given context. Patterns are usefull in multiple areas such as design, architecture, documentation, or process.
155
pattern-domain
Patterns are divided into different domains to group patterns.
156
pattern-type
Categorize patterns by type.
157
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).
158
person-type
Categorize persons by a type.
159
problem
Document problems as a means to communicate the details and to use the information for reviews and retrospections.
160
problem-type
Problems are grouped by their type.
161
process-impact
Impacts define how the results of processes affect the world.
162
process-impact-type

Type-specific category for impacts.

163
process-outcome
Outcomes define the results of processes.
164
process-outcome-type

Type-specific category for outcomes.

165
product-backlog
Product Backlogs are means to collect user stories.
166
profile
Profiles provide views on documents via delegation.
167
profile-type
Categorize profiles by a type.
168
project-constraint
Project Constraints limit the options of a project.
169
project-constraint-type
Project constraint types categorize project constraints.
170
project-rule
Project Rules are defined by the team to enhance the collaboration and to define project standards.
171
project-rule-type
Categorize project rules by type.
172
project vision
Frame the vision for a project or iteration.
173
project-vision-type
Types to categorize vision statements for projects.
174
property
Properties are part of the configuration options of a system.
175
property-type
Property types categorize properties of products, such as parameters or configuration options.
176
quality
Qualities describe desired aspects of the product.
177
quality-scenario
Quality Scenarios document required qualities.
178
quality-scenario-type
Quality scenario types categorize quality scenarios.
179
quality-target
Documents a quality target for a product.
180
quality-target-type
Group quality targets by their type.
181
quote
Quotes relevant for the project. Allows to store the content and metadata to the quote.
182
quote-type
Categorize quotes by a type.
183
relation
Organizes glossary items.
184
relation-type
Categorize relations by a type.
185
release
Releases document the changes that are applied to a published version of a service.
186
release-note
Document changes provided by a release of a product.
187
release-note-type
Group your release notes by a self-defined type.
188
release-type
Type-specific category for releases.
189
report
Reports document what the team has decided or done. This is a generic document.
190
report-type
Group your reports by a self-defined type.
191
requirement
Documents requirements of a product.
192
requirement-type
Categorization of requirements for a product.
193
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.
194
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.
195
retrospective
Record the discussion of the team about their last iteration.
196
review
Plan and run your review meeting.
197
review-act
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.
198
risk
Document and track identified risks for the project.
199
risk-action
Document actions to prevent or reduce the negative impact on exceptions on a project.
200
risk-action-type
Risk actions are grouped by their type.
201
risk-phase
Risks are grouped by the phase of their impact on the project.
202
risk-probability
Risks are grouped by the probability of having impact on the project.
203
risk-severity
Risks are grouped by the severity of their impact on the project.
204
risk-target
Document targets of risks.
205
risk-target-type
Risk tagets are grouped by their type.
206
risk-type
Risks are grouped by their type.
207
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.
208
role-type
Categorize roles by a type.
209
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.
210
section-type
Categorize sections by a type.
211
service-announcement

Announcements communicate with stakeholders information about a service.

212
service-announcement-type

Type-specific category for service announcements.

213
service-level
Describe a service level for a service.
214
service-level-agreement
Provide information about a service level agreement (SLA).
215
service-level-agreement-type

Type-specific category for service level agreements.

216
service-level-requirement
Describe a requirement in terms of a service level.
217
service-level-requirement-type
Type-specific category for service level requirements.
218
service-level-type

Type-specific category for service levels.

219
space-blueprint
Document the purpose and usage of a space blueprint.
220
space-blueprint-type

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

221
docsection
Compile other documents, yet space indices are themselves projectdoc documents. So they can be tagged and grouped.
222
space-index-type
Categorize space indexes by a type.
223
space-property
Space properties hold metadata of a space. They may be inherited by delegate spaces.
224
space-property-type

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

225
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.
226
stakeholder-type
Categorize stakeholders by a type.
227
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.
228
step-type
Categorize steps by a type.
229
strategy
Defines a strategy for an organization or product.
230
strategy-type

Type-specific category for strategies.

231
subject
Subject documents allow to set document instance of different doctypes in a common context.
232
subject-type
Categorize subjects by a type.
233
swot
Work on strengths, weaknesses, opportunities, and threats.
234
swot-type

Type-specific category for SWOTs.

235
tag
Document the semantics of a tag. May also be used to document Confluence labels.
236
tag-type
Categorize tags by a type.
237
team-process
Document processes defined and used by the team.
238
team-process-type
Categorize team processes by type.
239
technical-debt
Technical Debts track issues to be paid back.
240
technical-debt-type
Technical Debts are grouped by the area they address.
241
test-case
Document a test case of your project.
242
test-case-type
Test case types categorize test cases.
243
test-charter
Defines a charter to run an exploratory test session.
244
test-charter-type
Test charter types categorize test charters.
245
test-data
Document data used for test cases.
246
test-data-type
Test data types categorize test data.
247
test-report
Documents the results of a test session for the sponsoring stakeholders.
248
test-report-type
Test report types categorize test reports.
249
test-session
Defines a document to collect information during a test session.
250
test-session-type
Test session types categorize test sessions.
251
todo

Add a todo note to your developer diary.

252
todo-type

Categories for todos.

253
tool
Document tools used by the team. Add information about how to fetch, install and best practices using it.
254
tool-type
Categorize tools by type.
255
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.
256
topic-type
A topic type is a semantic type of the topic. It helps to set the expectations of potential readers.
257
tour
Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic.
258
trigger

Triggers define signals for activities and processes.

259
trigger-type

Type-specific category for triggers.

260
use-case
Defines a use case of the product.
261
use-case-type
Use case types categorize use cases.
262
user-character
User Characters are the actors of user stories. They include personas and extreme characters.
263
user-character-type
User character types categorize user characters.
264
user-story
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.
265
version
Document a version of a product or service.
266
version-type
Categorize versions by a type.
267
view
Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.
268
view-type
Groups the views at a system.
269
vision

Describe your vision for your career.

270
vision-statement
Define the vision for your organization or product.
271
vision-statement-type

Type-specific category for vision statements.

272
vision-type

Categories for visions.

273
week

Plan and run a retrospective for your week of work.

274
week-type

Categories for weeks.

275
whitebox
Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.
276
whitebox-type
Group whiteboxes by their type.
277
work-instruction
Work Instructions define procedures for processes. Provide the most detailed information here how tasks are to be executed. This includes best practices.
278
work-instruction-type
Type-specific category for work instructions.
279
year

Create a year in your Diary.

280
year-type

Categories for years.

Set names that are not rendered as links are not yet published.

Blueprint Key Prefixes by Add-on

The set named 'Native' refers to doctypes provided by the projectdoc Toolbox – which is actually only one doctype Blank Document Doctype.

Name Set Blueprint Key Prefix
Agile Team
de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-agileplanning:projectdoc-blueprint-doctype-
arc42
de.smartics.atlassian.confluence.smartics-projectdoc-confluence-arc42:projectdoc-arc42-blueprint-doctype-
Core
de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-core:projectdoc-blueprint-doctype-
Developer Diaries
de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-devdiary.projectdoc-blueprint-doctype-
Native
de.smartics.atlassian.confluence.smartics-projectdoc-confluence:projectdoc-blueprint-doctype-
Project Management
de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-prjmgmt:projectdoc-blueprint-doctype-
Risk Management
de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-riskmgmt:projectdoc-blueprint-doctype-
Software Development
de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-swdev:projectdoc-blueprint-doctype-

Doctype add-ons are available on the Atlassian Marketplace and on Bitbucket.