Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
render-asdefinition-list
Short DescriptionAdd roles to your space and set the audience of a topic document to one of the roles. 
Doctypetopichide
NameUsing Roles 
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 Duration1: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 Key000200hide
Section
Column
Section
titleDescription

Specifying the target of the audience is one of the first important tasks when creating a document for your technical documentation.

This screencast shows how to create roles and set the target audience of a topic document.

We show how to create two roles: Ops (Operations) and QRT (Quick Response Team). QRT is a specialized role to Ops. This is expressed by adding the QRT role document as a subdocument to the Ops document.

Note Box

Please note that short descriptions are usually one two three sentences long. The short descriptions in the screencast are short to spare your time. (smile)

What also is not shown: The detailed information on the role. Please refer to the Role doctype for details.

Section
titleReferences

Soundtrack

Column
Section
titlePrerequisites

None.

It may help, if you have watched the screencast on on micro  structure first.

Section
titleScreencast

Watch this screencast on YouTube:

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

...

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

 

...

Section
titleResources