Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionLists projects that use the projectdoc Toolbox for their documentation. We include real projects as well as interesting examples.
 

Doctypetopichide
NameProjects using the projectdoc Toolbox
 

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
 

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
propertyType
 

Sort Keyhide
Section
titleDescription

We use the projectdoc Toolbox for a number of projects. For each topic we work on, we create a new space with projectdoc.

If the project requires documentation, we create a space with a blueprint provided by the Core Doctypes. If it contains records that create a result, we use projectdoc Developer Diaries to organize our daily information. The Doctypes for Agile Planning are used to organize project related information to collaborate as a team. If we want to document a software project, we use Software Development Doctypes.

So here come a few live examples that use the projectdoc Toolbox.

Column

Section
titlePrerequisites

Section
titleAbstract

Section
titleprojectdoc

Eat your own dogfood! We have fun creating our documentation with our tool!

Tour
replace-title-with-nametrue
TitleShort DescriptionNotes
The projectdoc Toolbox for Atlassian Confluence
 

We decided to use a space blueprint from the Core Doctypes Add-on and completely redesigned the space homepage.
projectdoc Toolbox
 

We have decided to create a specialized add-on that provides templates to document Doctypes, Macros, and Doctools. The add-on is based the Core Doctypes Add-on since we target users of the plugin as the audience.
Section
titleMaven Plugins

We decided to move our documentation from the XDoc format to projectdoc on Confluence. This allows us to update the information independent of the release cycles of the products. We also take advantage of templates and macros that make it much easier to create the documentation collaboratively.

Display Table
doctypeproject
selectproject-artifact-id+, Short Description
space-keys@all
where$<Tags> = [maven-plugin]
header-translationsproject-artifact-id=Plugin

Section
titleDemo Spaces

We provided some space online to help you visualize some space you

Display Table
doctypeproject
selectName, Short Description
space-keys@all
where$<Tags> = [Demospace]

Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name
Section
required-permissionswrite-access
titleNotes

Section
titleReferences

Section
titleResources