Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionDocuments Describes a single step of an activity. A step is a generic document that is associated with a document that describes a process. It may be a test log or a howto. 
Doctypedoctypehide
NameStep 
IDstep 
SetCore 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Documentation Type
Name List
doctypedoctype-type
render-no-hits-as-blanktrue
namesQ1 - Process, Q2 - Project, Q3 - Product, Q4 - System
propertyDocumentation Type
 
Categories
Name List
doctypecategory
render-no-hits-as-blanktrue
names/ Document / Part
propertyDocumentation Type
 
Tags
Tag List
namesCore, Modular Documents, Allrounder, Subdocument
 
Iteration
Iteration
valuefilled
hide
Since4.2 
Sort Keyhide
Section
indextrue
titleDescription

Steps document the sequence of actions within an activity.

Describe steps to accomplish a task or to document what has been done. Different document types may require to explicitly describe the steps to do. Steps may also be used to define what has to be done to create a defined goal or to reproduce a result.

Section
titleProperties
Transclusion
documentNote Box referencing common Document Properties
idsBox

Section
titleSections
Section
titleDescription
Transclusion
documentDescription
idsDesignation

Describe the reason why this step is valuable and what readers may learn from reading this document.

Section
titleSummary

Describe what is the result of taking this step or what can be learned after finishing this step.

transclusion-macrodocumentDesignation

projectdoc-
Section
titleActions

Describe what has actually to be or has been done to execute this step. This may include screenshots and more than one step.

If there are too many steps that need to be explained, add additional step documents as children to this document.

Summaryids
Section
titleSubordinate Steps

If a step is composed of a number of subordinate steps you need to document independently, add them as children to this document.

Transclusion
documentDocument Sections
idsstandard-sections-bottom

...