projectdoc Toolbox

Checklists allow to run manual tasks in a defined manner. It guides the user of the checklist through a process and helping to not forget a step.

ID
checklist
Suite
Parent
Documentation Type
Categories
/ Work / Definition
Tags
Teamwork

Create a checklist to support team members in executing regular tasks that have not (yet) been automated. Checklists allow to run manual tasks in a defined manner. It guides the user of the checklist through a process and helps to not forget a step.

A checklist is a lightweight process defined by the team. Agile teams usually work closely together and therefore have little need to document how they are doing things. In addition to that, agile teams usually seek to automate repetitive tasks and have their process descriptions in form of scripts.

But if the need arises, that a team decides to document how specific things should be done, the checklist document type is useful. It may also be the first attempt to describe a process before it is scripted. Some processes may not be scriptable, because they mainly describe the interaction between roles in the team. The document may also concentrate on answering the why instead of the how questions. It may be a mere anchor to reference a script from the wiki documentation.

 

For documenting IT processes consider the IT Process doctype of the Doctypes for Service Management add-on.

Properties

The document type checklist 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.

Type

Specify the type of the checklist to organize them.

Use the Checklist Type to define types of checklists.

Sections

Description

Describe the purpose of the checklist. This may include reasons why this has not (yet) been automated.

Context

Provide background information for the reader to understand the task that is accomplished by following the checklist.

Prerequisites

Provide information about what has to be done before to start with the checklist.

Steps

Describe the steps of the checklist. Each step is described in its own subsection. Consider to use the Steps Macro.

Postrequisites

Provide information about what has to or can be done after finishing the steps of this checklist.

Result

Describes the result - if not obvious - the user of the checklist has received.

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.