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.

ID
step
Suite
Core
Documentation Type
Categories
/ Document / Part
Tags
Since
4.2

Description

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.

Properties

The document type step provides the following properties:

Sections

Description

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

Summary

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

Actions

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.

Subordinate Steps

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

Notes

These are internal notes that are usually not exported and only visible to team members with write access.

But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.

References

For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.

Resources

The resources section provides references to further information to the topic of the document.

This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.