Procedure:Write new SOP

From OpenVCE

Jump to: navigation, search

This page describes how to write a new Standard Operating Procedure (procedure, or SOP) using the MediaWiki SOP extension. Some familiarity with MediaWiki and its page editing mechanism is assumed. The procedure described here can be applied to create an SOP and thereby constitutes an example of an SOP that can be inspected using the edit tab.

Subtask: Create SOP article

The first step is to create a new, empty article in the wiki. SOPs must be described in the Procedure namespace that is defined by the MediaWiki SOP extension. To create a new article in this namespace first search for the new title prefixed by the namespace, e.g. "Procedure:Write new SOP". If no such article exists, a link should allow for the creation of this new article.

Note that the default search may be configured to search in the Main namespace only.

Subtask: Describe SOP informally

The easiest way to start writing an SOP is to use standard Wikitext (see Help:Editing) to informally describe the procedure. This will then form the basis for a more formal version. However, even the informal version should follow a certain pattern based on the following ideas:

  • every procedure must accomplish an objective that is part of the description
    • there can be at most one objective for a procedure
    • there may be multiple procedures that accomplish the same objective
  • a procedure may be broken down into subtasks
    • subtasks must be accomplished in the order defined in the procedure
    • subtasks can be accomplished by procedures that have the subtask as their objective

Subtask: Mark up SOP

A procedure can be marked up with a number of tags (implemented as MediaWiki parser functions). The name of a procedure is the title of the article (which should start with a verb) and is used to refer to the SOP. The {{#objective:...}} tag can be used to define the objective accomplished by the procedure. The {{#subtask:...}} tag defines the subtasks that need to be accomplished when this procedure is implemented.

Personal tools