projectdoc Toolbox

IT Procedures define procedures for processes.

ID
it-procedure
Suite
Parent
Documentation Type
Categories

Procedures show how processes and their activities are actually run by people. They explain the who, when, and why, where processes only abstractly explain the what.

If you need to get into greater detail about what steps are actually conducted, use the work instruction.

Properties

The document type it-procedure provides the following properties:

 

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Superordinate Procedure

Procedures may be composed. This is a reference to the superordinate procedure.

The value is typically automatically provided by the parent document.

Type

Specify the type of the IT procedure to organize them.

Use the IT Procedure Type Doctype to define types of procedures.

Roles

List the roles that take part in running this procedure.

 

While the Audience property describes the groups of readers interested in this document, the Roles property describe the roles that actually take part in it.

Typically all roles involved are part of the audience, unless their part is passive.

Sections

Description

Describe the procedure and the people involved to run it.

Work Instructions

List detailed instructions of work associated with this procedure.

Use the Work Instruction Doctype to provide these details.

Subordinate Procedures

Complex or long procedures may be broken up into a number of procedure document instances.

As long as the subprocedures are not shared, add them as children to this document. If a procedure is shared, put it to the homepage of procedures.

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.

 

The text of notes sections is also indexed.

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.

 

For further information please refer to References and Resources.

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.

 

For further information please refer to References and Resources.