Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
hidetrue
overridefalse
Short DescriptionLearn about properties and sections of a document. 
Doctypetopichide
NameDoctypes in Detail 
Parent
Parent Property
propertyParent
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesDocumentation Architect, Author
propertyAudience
 
Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesNovice
propertyLevel of Experience
 
Expected Duration 
Subject
Name List
doctypesubject
propertySubject
 
Categories
Name List
doctypecategory
propertyCategories
 
Tags
Tag List
propertyTags
 
Iteration
Iteration
valuefilled
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTutorial
propertyType
 
Previous StepCreate a Workspacehide
Next StepThe Workhorse Macroshide
Sort Key000400hide
Section
titleDescription

Section
titleSummary

...

Section
titleBackground Information
Expand
titleShow background information ...
Section
titleDoctypes

Doctypes define document properties and document sections. Each property may have a value or not, each section may have content or not.

Note Box

To be precise, only the Doctype, the Name and the Short Description have to be defined. All other properties may have blank values.

The system only complains if the doctype is missing. The name should be present and it is good practice to have a short description.

If a property has no value or a section has no content, it is not rendered. Therefore a doctype is not a template that requires to be filled out. It is a tool to guide authors to create new documents based on the team's conventions.

Authors may add new properties and sections and remove all non-mandatory properties and all sections, if they think these do not apply. But since empty content is not displayed to the reader, it is good practice to leave them in the template. If in the future a new information has to be added, the author still has the guidance provided by the doctype to add it to the location defined by the team's convention.

Transclusion
render-document-name-as-headingtrue
taget-heading-level*
documentDocument Properties
ids-Description, !*

Transclusion
render-document-name-as-headingtrue
taget-heading-level*
documentDocument Sections
ids-Description, !*

Section
titleBlueprint Wizards

Doctypes not only provide a basic structure by the use of properties and sections. They also provide a wizard that supports authors to create documents. A wizard is a step by step guidance to collect information to be added to the new document.

Section
titleAgile Documentation

Agile documentation proposes to have documentation that is

  1. valuable - has a stakeholder that is in need for the information
  2. essential - contains only the required information for the stakeholder
  3. timely - create just-in-time for the stakeholder

With this in mind it is important to be able to define the doctypes according to the team's requirements. Therefore all our doctype add-ons are available for free on the Marketplace and are published with an open source license on Bitbucket. Feel free to use them as a basis to define your own set of doctypes.

Section
titleUser Templates

If you need only minor changes to the doctypes, which especially do not require changes to the blueprint wizard, you may simply edit the installed templates of the free doctypes.

Please note that we are constantly working on the doctypes. Make sure that you understand the additional work you have to invest in developing your own version of the doctypes.

...