Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
render-asdefinition-list
Short DescriptionHome and index pages help to organize documents by type. For each doctype there is a homepage and and index page. The homepage shows the central documents that are added to it (immediate children). Index pages list all documents of the space, regardless of their location.
 

Doctypetopichide
NameHome and Index Pages
 

Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesNovice
propertyLevel of Experience
 

Expected Duration0:45 minutes
 

Categories
Name List
doctypecategory
propertyCategories
hide
Tags
Tag List
namesScreencast
propertyTags
hide
Iteration
Iteration
valuefilled
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTutorial
propertyType
 

Sort Key000300hide
Section
Column
Section
titleDescription

projectdoc provides two ways of organizing document. One is by type, the other by semantics.

Ordering by type allows readers to find the information at well known places, since it is a standard that can be used in every project. Software developers using Maven are used to this kind of structuring: in every project the source files are found in src/main, the test files in src/test and so on.

Home and index pages support organizing documents by type. For a project documentation this results in having the project roles, stakeholders, tags, and categories (just to name a few) all in one place. At the same place for all projects using projectdoc. The homepage contains the central documents of their types. For roles these central documents provide information about the root roles of the project.

In the given example we use the following roles:

  • Ops (Operations)
    • QRT (Quick Response Team, a special branch of Operations)
  • Users (Users of the system under development)

Index pages are linked to homepages and show all documents of the given doctype (up to a maximum according to the result set size). This is useful for readers that want to get an overview over all documents of a given type.

Section
titleReferences

Soundtrack

Column
Section
titlePrerequisites

None.

It may help, if you have watched the screencast on Using Roles first.

Section
titleScreencast

Watch this screencast on YouTube:

Widget Connector
urlhttps://www.youtube.com/watch?v=6nN0jqyPP_o&list=UU1KxO6B5vj7_yPAleMIgErA

...

Section
required-permissionswrite-access
titleNotes

Section
titleResources
Tour
render-as-definition-listtrue
replace-title-with-nametrue