In order to not duplicate the information about common properties provided by all doctypes, this box allows to reference the topic that provides this information.

Type: Box

Description

The following placeholders are provided to configure the output:

Name	Description
doctype-name	The name of the document type (doctype) that is documented. Provided this box as a reference to common document properties that are supported by theis document type by default.

Box

The document type ${doctype-name} provides the following properties:

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Transcluded By

Name	Short Description	Doctype
Introduction and Goals	The first chapter of the arc42 Template with information on requirements, quality goals, and stakeholders.	doctype
Architecture Constraints	The second chapter of the arc42 Template with information on constraints and conventions.	doctype
System Scope and Context	The third chapter of the arc42 Template with information on context and external interfaces.	doctype
Solution Strategy	The fourth chapter of the arc42 Template explains the solution idea.	doctype
Building Block View	The fifth chapter of the arc42 Template with information on the local building blocks, and their dependencies and relationships.	doctype
Runtime View	The sixth chapter of the arc42 Template with runtime information about the architecture.	doctype
Deployment View	The seventh chapter of the arc42 Template with information about how the system is deployed.	doctype
Cross-cutting Concepts	The eighth chapter of the arc42 Template with conceptional information about the system.	doctype
Design Decisions	The ninth chapter of the arc42 Template that explains the architecture decisions that led to the system.	doctype
Quality Requirements	The tenth chapter of the arc42 Template that lists scenarios to systematically evaluate the architecture against the quality requirements.	doctype
Risks and Technical Debts	The eleventh chapter of the arc42 Template lists risks and technical debt.	doctype
Glossary	The last chapter of the arc42 Template lists terms of the domain and explains them.	doctype
Access Information	Credentials for development systems where the password is known to all who have access to the Confluence wiki.	doctype
Access Information Type	Type-specific category for access information.	doctype
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.	doctype
Alternative Type	Group your alternatives by a self-defined type.	doctype
Announcement	Announcements are a way to communicate an important piece of information with your team.	doctype
Annual Vision	Describe your vision for one year. You plan will help you stay focussed to accomplish your goals.	doctype
Annual Vision Type	Categories for annual visions.	doctype
App	Document your app for your users and customers.	doctype
App Component	Provide more detailed information about a component of a tool.	doctype
App Component Type	Document the purpose and usage of the components of this type.	doctype
App Extension	Document your extension for your users and customers.	doctype
App Extension Type	Document the purpose and usage of the extension of this type.	doctype
Application	Applications provided functions required by services. Applications may be hosted on one or more systems.	doctype
Application Type	Type-specific category for applications.	doctype
App Macro	Document the purpose and usage of the macro.	doctype
App Macro Type	Document the purpose and usage of the macros of this type.	doctype
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!	doctype
App Parameter Type	Document the purpose and usage of the app parameters of this type.	doctype
App Platform	Document a platform for apps.	doctype
App Platform Type	Document the purpose and usage of the platforms of this type.	doctype
App Service	Document a service provided by an app.	doctype
App Service Type	Document the purpose and usage of the app services of this type.	doctype
App Tool	Document a tool provided by an app.	doctype
App Tool Type	Document the purpose and usage of the app tools of this type.	doctype
App Type	Document the purpose and usage of the apps of this type.	doctype
arc42 Template	The blueprint of the arc42 Template creates a tree of pages in the Confluence space.	doctype
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.	doctype
Architecture Alternative Type	Group architecture alternatives by their type.	doctype
Architecture Aspect	Document an aspect of your architecture. Something orthogonal or cross-functional like logging, exception handling or configurability.	doctype
Architecture Aspect Type	Group architecture aspects by their type.	doctype
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.	doctype
Architecture Decision Type	Architecture decisions are group by their types. A commonly used decision type is 'Architecture'.	doctype
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.	doctype
Artifact Type	Artifact types categorize artifacts.	doctype
Asset	Explain an asset of your work. Add this document to a day in your diary.	doctype
Asset Type	Categories for assets.	doctype
Association	Associates two documents.	doctype
Association Type	Categorize associations by a type.	doctype
Assumption	Document assumptions to assess risks and opportunities for the project.	doctype
Assumption Type	Assumptions are grouped by their type.	doctype
Blackbox	Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.	doctype
Blackbox Type	Group blackboxes by their type.	doctype
Blank Document	The blank template simply provides a minimal integration with projectdoc features. It is a quick starting point to use projectdoc.	doctype
Category	Categories allow to set document instance of different doctypes in a hierarchy.	doctype
Category Type	Categorize categories by a type.	doctype
Change	Document a single change to configuration items or assets.	doctype
Change Severity	Add an severity to classify changes.	doctype
Change Status	Add a status to categorize changes.	doctype
Change Theme	Add a theme to group changes.	doctype
Change Type	Type-specific category for changes.	doctype
Charter	Describes an information need and use this description as a basis to create and maintain a document.	doctype
Charter Type	Categorize charters by a type.	doctype
Cheat	A brief solution to a problem.	doctype
Cheat Type	Categories for cheats.	doctype
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.	doctype
Checklist Type	Categorize checklists by type.	doctype
Code	Describe the codes that are part of the product's API.	doctype
Code Type	Code types categorize codes, used in logging or exception handling.	doctype
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.	doctype
Component Type	Component types categorize components.	doctype
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.	doctype
Configuration Item Status	Signals the status of an IT system, application, or a configuration item.	doctype
Configuration Item Type	Type-specific category for configuration items.	doctype
Cycle	Add cycles to group cycle phases.	doctype
Cycle Phase	Cycle phases define phases that are bound to a cycle, such as lifecycles or iterations.	doctype
Dataset	Datasets are used as the input and output of processes.	doctype
Dataset Type	Type-specific category for datasets.	doctype
Data Type	Document a data type for properties and codes.	doctype
Data Type Type	Data type types categorize data types.	doctype
Day	Store relevant information discovered today in your developer diary.	doctype
Day Type	Categories for days.	doctype
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.	doctype
Decision Type	Group your decisions by a self-defined type.	doctype
Deployment	Deployments provide information about updates on services and systems to users.	doctype
Deployment Record	Record a deployment to a IT system.	doctype
Deployment Record Type	Type-specific category for deployment records.	doctype
Deployment Type	Type-specific category for deployments.	doctype
Diary Type	Categories for diaries.	doctype
Doctype	Document the usage of a doctype for your users.	doctype
Doctype Type	Document the purpose and usage of the doctypes of this type.	doctype
Document Property	Document the usage of a document property for your users.	doctype
Document Property Type	Document the purpose and usage of the properties of this type.	doctype
Document Section	Document the usage of a document section for your users.	doctype
Document Section	Document the purpose and usage of the sections of this type.	doctype
Environment	Document logical or physical groups of nodes.	doctype
Environment Type	Type of an environment used by the project to deploy the application or the solution.	doctype
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.	doctype
Event Type	Categories for events.	doctype
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.	doctype
Excerpt Type	Categorize excerpts by a type.	doctype
Experience Level	Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach.	doctype
Experience Level Type	Categorize experience levels by a type.	doctype
FAQ Type	Categorize FAQs by a type.	doctype
Feature	Documents a feature of the product. The top features define the main aspects of the product.	doctype
Feature Type	Feature types categorize features.	doctype
Generic	Generic Documents provide information where no other doctype matches.	doctype
Generic Type	Categorize generic documents by a type.	doctype
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.	doctype
Glossary Item Type	Categorize glossary items by a type.	doctype
Improvement	Improvement proposals help to start the conversation within the team for process improvements.	doctype
Interface	Interfaces document how elements of the system communicate with elements of this and other systems.	doctype
Interface Type	Group interfaces by their type.	doctype
IT Activity	IT Activities define activities for processes.	doctype
IT Activity Type	Type-specific category for IT activities.	doctype
IT Asset	IT Assets define assets required or produced by processes.	doctype
IT Asset Type	Type-specific category for IT assets.	doctype
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.	doctype
IT Function	Functions are specialized organizational units to support business processes.	doctype
IT Function Type	Type-specific category for IT functions.	doctype
IT Procedure	IT Procedures define procedures for processes.	doctype
IT Procedure Type	Type-specific category for IT procedures.	doctype
IT Process	Processes organize activities to create a defined business value.	doctype
IT Process Type	Type-specific category for IT processes.	doctype
IT Service	IT Services provide business relevant services for customers.	doctype
IT Service Classification	Classifiers to categorize services.	doctype
IT Service Classification Type	Type-specific classification for IT services.	doctype
IT Service Status	Signals the status of an IT Service.	doctype
IT Service Type	Type-specific category for IT services.	doctype
IT System	Systems are part of environments where products are deployed to.	doctype
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.	doctype
Lifecycle	Add lifecycles to group lifecycle phases.	doctype
Lifecycle Phase	Lifecycle phases define phases that are bound to a lifecycle.	doctype
Location	Locations provide information about the whereabouts of assets, configuration items, and systems.	doctype
Location Type	Type-specific category for locations.	doctype
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.	doctype
Media Type Type	Categorize media types by their type.	doctype
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.	doctype
Metadata Type	Categorize metadata documents by a type.	doctype
Minutes	Record the action items of a meeting.	doctype
Minutes Type	Group your minutes by a self-defined type.	doctype
Mission Statement	Define a mission for your company or product.	doctype
Mission Statement Type	Type-specific category for mission statements.	doctype
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.	doctype
Module Type	Categorization of document modules for single sourcing.	doctype
Month	Plan and run a retrospective for your month of work.	doctype
Month Type	Categories for months.	doctype
Node	Nodes are part of environments where artifacts are deployed to.	doctype
Node Type	Node types categorize nodes.	doctype
Open Issue	Open issues document what the team needs to know to proceed.	doctype
Open Issue Severity	Open issues are grouped by the severity of their impact on the project.	doctype
Open Issue Status	Open issues are grouped by the status.	doctype
Open Issue Type	Group your open issues by a self-defined type.	doctype
Opportunity	Document and track identified opportunities for the project.	doctype
Opportunity Type	Opportunities are grouped by their type.	doctype
Organization Type	Categorize organizations by a type.	doctype
Out Item Type	Out item types categorize out items.	doctype
Page Blueprint	Document the purpose and usage of a page blueprint.	doctype
Page Blueprint Type	Document the purpose and usage of the page blueprints of this type.	doctype
Pattern	Patterns provide solutions for problems in a given context. Patterns are usefull in multiple areas such as design, architecture, documentation, or process.	doctype
Pattern Domain	Patterns are divided into different domains to group patterns.	doctype
Pattern Type	Categorize patterns by type.	doctype
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).	doctype
Person Type	Categorize persons by a type.	doctype
Problem	Document problems as a means to communicate the details and to use the information for reviews and retrospections.	doctype
Problem Type	Problems are grouped by their type.	doctype
Process Impact	Impacts define how the results of processes affect the world.	doctype
Process Impact Type	Type-specific category for impacts.	doctype
Process Outcome	Outcomes define the results of processes.	doctype
Process Outcome Type	Type-specific category for outcomes.	doctype
Product Backlog	Product Backlogs are means to collect user stories.	doctype
Profile	Profiles provide views on documents via delegation.	doctype
Profile Type	Categorize profiles by a type.	doctype
Project Constraint	Project Constraints limit the options of a project.	doctype
Project Constraint Type	Project constraint types categorize project constraints.	doctype
Project Rule	Project Rules are defined by the team to enhance the collaboration and to define project standards.	doctype
Project Rule Type	Categorize project rules by type.	doctype
Project Vision	Frame the vision for a project or iteration.	doctype
Project Vision Type	Types to categorize vision statements for projects.	doctype
Property	Properties are part of the configuration options of a system.	doctype
Property Type	Property types categorize properties of products, such as parameters or configuration options.	doctype
Quality	Qualities describe desired aspects of the product.	doctype
Quality Scenario	Quality Scenarios document required qualities.	doctype
Quality Scenario Type	Quality scenario types categorize quality scenarios.	doctype
Quality Target	Documents a quality target for a product.	doctype
Quality Target Type	Group quality targets by their type.	doctype
Quote Type	Categorize quotes by a type.	doctype
Relation	Organizes glossary items.	doctype
Relation Type	Categorize relations by a type.	doctype
Release	Releases document the changes that are applied to a published version of a service.	doctype
Release Note	Document changes provided by a release of a product.	doctype
Release Note Type	Group your release notes by a self-defined type.	doctype
Release Type	Type-specific category for releases.	doctype
Report	Reports document what the team has decided or done. This is a generic document.	doctype
Report Type	Group your reports by a self-defined type.	doctype
Requirement	Documents requirements of a product.	doctype
Requirement Type	Categorization of requirements for a product.	doctype
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.	doctype
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.	doctype
Retrospective	Record the discussion of the team about their last iteration.	doctype
Review	Plan and run your review meeting.	doctype
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.	doctype
Risk	Document and track identified risks for the project.	doctype
Risk Action	Document actions to prevent or reduce the negative impact on exceptions on a project.	doctype
Risk Action Type	Risk actions are grouped by their type.	doctype
Risk Phase	Risks are grouped by the phase of their impact on the project.	doctype
Risk Probability	Risks are grouped by the probability of having impact on the project.	doctype
Risk Severity	Risks are grouped by the severity of their impact on the project.	doctype
Risk Target	Document targets of risks.	doctype
Risk Target Type	Risk tagets are grouped by their type.	doctype
Risk Type	Risks are grouped by their type.	doctype
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.	doctype
Role Type	Categorize roles by a type.	doctype
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.	doctype
Section Type	Categorize sections by a type.	doctype
Service Announcement	Announcements communicate with stakeholders information about a service.	doctype
Service Announcement Type	Type-specific category for service announcements.	doctype
Service Level	Describe a service level for a service.	doctype
Service Level Agreement	Provide information about a service level agreement (SLA).	doctype
Service Level Agreement Type	Type-specific category for service level agreements.	doctype
Service Level Requirement	Describe a requirement in terms of a service level.	doctype
Service Level Requirement Type	Type-specific category for service level requirements.	doctype
Service Level Type	Type-specific category for service levels.	doctype
Space Blueprint	Document the purpose and usage of a space blueprint.	doctype
Space Blueprint Type	Document the purpose and usage of the space blueprints of this type.	doctype
Space Index	Compile other documents, yet space indices are themselves projectdoc documents. So they can be tagged and grouped.	doctype
Space Index Type	Categorize space indexes by a type.	doctype
Space Property	Space properties hold metadata of a space. They may be inherited by delegate spaces.	doctype
Space Property Type	Document the purpose and usage of the space properties of this type.	doctype
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.	doctype
Stakeholder Type	Categorize stakeholders by a type.	doctype
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.	doctype
Step Type	Categorize steps by a type.	doctype
Strategy	Defines a strategy for an organization or product.	doctype
Strategy Type	Type-specific category for strategies.	doctype
Subject	Subject documents allow to set document instance of different doctypes in a common context.	doctype
Subject Type	Categorize subjects by a type.	doctype
SWOT	Work on strengths, weaknesses, opportunities, and threats.	doctype
SWOT Type	Type-specific category for SWOTs.	doctype
Tag	Document the semantics of a tag. May also be used to document Confluence labels.	doctype
Tag Type	Categorize tags by a type.	doctype
Team Process	Document processes defined and used by the team.	doctype
Team Process Type	Categorize team processes by type.	doctype
Technical Debt	Technical Debts track issues to be paid back.	doctype
Technical Debt Type	Technical Debts are grouped by the area they address.	doctype
Test Case	Document a test case of your project.	doctype
Test Case Type	Test case types categorize test cases.	doctype
Test Charter	Defines a charter to run an exploratory test session.	doctype
Test Charter Type	Test charter types categorize test charters.	doctype
Test Data	Document data used for test cases.	doctype
Test Data Type	Test data types categorize test data.	doctype
Test Report	Documents the results of a test session for the sponsoring stakeholders.	doctype
Test Report Type	Test report types categorize test reports.	doctype
Test Session	Defines a document to collect information during a test session.	doctype
Test Session Type	Test session types categorize test sessions.	doctype
Todo	Add a todo note to your developer diary.	doctype
Todo Type	Categories for todos.	doctype
Tool	Document tools used by the team. Add information about how to fetch, install and best practices using it.	doctype
Tool Type	Categorize tools by type.	doctype
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.	doctype
Topic Type	A topic type is a semantic type of the topic. It helps to set the expectations of potential readers.	doctype
Tour	Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic.	doctype
Trigger	Triggers define signals for activities and processes.	doctype
Trigger Type	Type-specific category for triggers.	doctype
Use Case	Defines a use case of the product.	doctype
Use Case Type	Use case types categorize use cases.	doctype
User Character	User Characters are the actors of user stories. They include personas and extreme characters.	doctype
User Character Type	User character types categorize user characters.	doctype
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.	doctype
Version	Document a version of a product or service.	doctype
Version Type	Categorize versions by a type.	doctype
View	Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.	doctype
View Type	Groups the views at a system.	doctype
Vision	Describe your vision for your career.	doctype
Vision Statement	Define the vision for your organization or product.	doctype
Vision Statement Type	Type-specific category for vision statements.	doctype
Vision Type	Categories for visions.	doctype
Week	Plan and run a retrospective for your week of work.	doctype
Week Type	Categories for weeks.	doctype
Whitebox	Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.	doctype
Whitebox Type	Group whiteboxes by their type.	doctype
Work Instruction	Work Instructions define procedures for processes. Provide the most detailed information here how tasks are to be executed. This includes best practices.	doctype
Work Instruction Type	Type-specific category for work instructions.	doctype
Year	Create a year in your Diary.	doctype
Year Type	Categories for years.	doctype

Note Box referencing common Document Properties

Description

Box

Transcluded By