Doctypes

Document Properties Marker

doctype	docsection
hide	true
extract-short-desc	true

Doctype	docsection	hide
Name	Doctypes
Short Description	Doctypes define properties and sections for documents. They are essentially Confluence Blueprints that help to create pages in your wiki based on templates.
Tags	documentation, projectdoc Toolbox, Doctype Add-on, Confluence, Page Blueprints, Space Blueprints, Templates
Type	Doctype Set	hide
Set	Native	hide
Blueprint Key Prefix	`de.smartics.atlassian.confluence.smartics-projectdoc-confluence:projectdoc-blueprint-doctype-`	hide
Sort Key		hide

Section

show-title	false
title	projectdoc Doctypes

Doctypes help authors to add their information in a uniform way. This uniform way support the authors to concentrate on the content and not be distracted by formatting or coarse structuring issues. It also helps readers to find the information more quickly.

Tip Box

title	Teams should only write documentation that is essential and valueable

Templates are only a tool. If the information demands it, authors are free to add or adapt the templates to their needs. It is the ease of accessing information that counts, not the adherence to standards.

Please keep in mind to discuss deficiencies with your team members and documentation architects to continuously improve the documentation structure and tools.

Keep your documentation essential, valuable and write it just-in-time!

We assembled some quotes according to documentation writing on the projectdoc homepage. Get inspired on how to design your project documentation!

Doctypes are implemented as page blueprints, which Confluence allows to adjust to your needs. Teams should decide what elements are worthy to use and which should be discarded. After all there must be a return of investment and every asset, which includes documents, is also a (potential) liability.

To get you started with projectdoc quickly we recommend to install the Core Doctypes. With this basic set of blueprints you may start spaces to document topics that are relevant for your team. We also provide (and plan to provide) additional doctype add-ons for other areas of project documentation.

Tip Box
Have a look at the doctype add-ons that are already available on the Atlassian Marketplace!

The projectdoc Add-on provides only a demonstration space and the Blank Document doctype.

projectdoc-hide-from-anonymousreader-usermacro

Create from template

spaceKey	PDAC1
blueprintModuleCompleteKey	de.smartics.atlassian.confluence.smartics-projectdocdoctype-confluenceaddon-space-projectdocapp:projectdoc-blueprint-doctype-doctype
contentBlueprintId	5812e51e163a2a76-e1dddeab-48b04f9c-9c799a7d-abde85f35c517db675bfd7ac
templateName	5812e51e163a2a76-e1dddeab-48b04f9c-9c79-abde85f35c519a7d-7db675bfd7ac
createResult	edit
buttonLabel	New Doctype

Content Marker

hide	true

Wiki Link

page	projectdoc.content.doctypes.index.all.title

Panel

Related Documentation

The following links direct you to related documentation within this wiki.

Wiki Link
page projectdoc.content.macros.home.title
Extensions
Wiki Link
page projectdoc.content.doctools.home.title

Content Marker

id	localization

Note Box

title	English and German by Default

All doctype add-ons are available in English and German language (except for the V-Modell XT add-on for which only supports German).

For more information on this topic please refer to Localization.

Panel

borderColor	lightgrey

Take an alternative introduction to the Core Doctypes

Or have a look at Doctypes Introduction.

Transclusion

taget-heading-level	*
document	Core Doctypes
ids	Create a Space

Section

title	Core Doctypes

The following document types are part of the Core Doctypes Add-on.

Tip Box
You may also take an alternative introduction to the Core Doctypes by a Prezi presentation. The presentation provides a good overview by grouping closely related doctypes.

The core doctypes provide the base for your agile documentation work. You may also use them as an inspiration for designing your own templates that meet exactly the requirements of your project.

Please refer to Tour for Document Authors for an introduction on how to use these templates and to Tour for Template Authors for information on how to design your own templates.

Transclusion

document	Core Doctypes
ids	access-info

Display Table

doctype	doctype
select	Name, Short Description, Categories
restrict-to-immediate-children	true
sort-by	Sort Key, Name
where	Tags = "Core"
render-counter-column	true

Find more doctypes in the extensions!

Section

title	Extension Doctypes

The following doctypes are not part of the Core Doctypes Add-on, but are (or will soon be) available in separate packages.

Separate add-ons make it easy for teams to select those doctypes that are useful for them and their specific project requirements.

Tip Box

Please make sure to check those extension doctypes. Maybe they are not provide exactly to what you require, but they can be a good starting point.

For minor changes Confluence allows to adjust the templates easily. For larger changes we recommend to create a blueprint project and build your own add-on. If you have developers on your team, this may be much easier than you think. Please refer to Tour for Template Authors for an overview on how to do this. We plan to release some of our doctype projects on GitHub to make you get started with your own add-on extensions more quickly.

Section

Column

Content Marker

id	list-extension-doctypes

Display Table

doctype	topic, app
render-mode	definition
select	Name, Status\|, Short Description
restrict-to-immediate-children	true
where	$<Doctype>~(topic,app) NOT Tags=Core

Column

Panel

titleColor	white
titleBGColor	orange
title	Install additional Doctypes!

Install the Doctype Add-ons now and for free via

Transclusion

document	Doctype Add-on Sources
ids	All

Transclusion

document	Add-on Available soon Notice
ids	Description

Content Marker

hide	true

Wiki Link

page	projectdoc.content.doctypes.index.all.title

Section

title	References

Section

title	Resources

Display Table

render-no-hits-as-blank	true
render-mode	definition
where	$<Tags> = [Doctype] NOT $<Doctype> = [faq]
exclude-self	true

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 13

New Version 14

Key

About

Keep up-to-date!

Powered by