Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section


Column


Document Properties Marker
doctypetopic
hidetrue
overridefalse
extract-short-desctrue


 

Image Removed

Core 
Short DescriptionProvides a basic set of doctypes to create agile documentation. Doctypetopichide
NameCore Doctypes 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
 
Expected Duration 
Categories
Name List
doctypecategory
names/ projectdoc / Doctype Add-on
propertyCategories
 
Tags
Tag List
namesDoctype Add-on, Core
propertyTags
 

Iteration
Iteration
valuefinished
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesDoctype Set
propertyType
 
Status
Status
colourGreen
titleavailable

Sort Key000010hide
Project Logo
Core
hide
Marketplace URLhttps://marketplace.atlassian.com/1212810hide
SetCore
OptionalMaven Extensionhide




Column
width200px220px


Document Properties Supplier
cssmeet
render-asdefinition-list


Blueprint Key Prefixde.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-core:projectdoc-blueprint-doctype-hide
Requires projectdoc
Display Space Property
property-nameproject-version
 
6.0
hide
Optional Maven Extension18.0.2 hide





Content Marker
idaccess-info


Section


Column


Panel
titleColorwhite
titleBGColororange
titleInstall Core Doctypes!

Install the Core doctypes add-on now and for free via

Image Modified



Column


Transclusion
documentDoctype Add-on Sources
idsCore





...

Section


Column


Section
show-titlefalse
titleDescription

The core doctypes provide the base for your agile documentation work with the projectdoc Toolbox for Confluence. 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.



Column


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.



...

Section
titleCreate a Space

To get started with the Core Doctypes, we recommend to create an Agile Documentation Core Project Space.

Image RemovedImage Added

This provides the basic structure to add new documents easily by the use of home and index pages. This is how the space looks like:Image Removed

Image Added

If you prefer to start with a relatively blank space, consider to choose the Configuration Space. It creates a home page and an index page for type documents.

Section
titleList of Space Blueprints

The following space blueprints are provided by the Core Doctypes.

Definition List


Address Book

Manage information about people and their roles and interests in a product or project. This space contains information about roles, persons, and organizations.

Configuration Space

Manage commonly used configurations without any subdocuments (besides a homepage for type homepages).

Core Project Space

Create a space to organize information for your agile team. A basic structure with homepages is created, such as for tags, topics, or roles).

Glossary

Manage information about a domain. Add glossary items and associate them with domain information.

Index Space

Collect commonly used information like spaces properties or type documents. You may also include fragments to be used by transclusion or other information that is relevant for all dependent spaces.

Library

Manage information about resources. This includes books, articles, podcasts, as well as information about the authors of these resources.

Topic SpaceCreate a space to collect and organize information on a topic.
Workspace

Create a space to collaboratively collect information on a specific topic. A workspace does not demand for updating information. It is a place to work with until a goal is reached. Move the result of your research to topic spaces and discard or archive this space.





Section
titleList of Doctypes

The doctypes provided by Core Doctypes are very basic and sometimes generic. Note that there are additional doctype add-ons that support the documentation of more specific domains. The doctypes provided by Core Doctypes are often also used in these domains, for instances roles or tags.

The following doctypes help to document the system.organize core project or product information. 

Display Table
doctypedoctype
selectName, Short Description, Documentation Type, Categories
sort-bySort Key, Name
whereTags = "Core"
render-counter-columntrue

...

Section
titleReferences


Section
titleResources

Related information to work with Core Doctypes

- more doctypes for projectdoc
Macros - macros to be used in your doctype templates

.

Tour
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue


TitleShort Description
DoctypesMore information on doctypes for the projectdoc Toolbox.
Extension DoctypesList of additional doctypes provided by free add-ons for specific domains.
MacrosList of macros from the projectdoc Toolbox to be used in your Confluence blueprints (2013).
projectdoc Document