SOP How To

The following is an SOP on writing an SOP. Click on the "Edit" tab, top, right, to open this page in the editor (an account is required). Select all or a portion the text and copy it to the clipboard (ctrl-c). Paste into the new document you wish to create following the instructions, just below. Update text and filenames in the new document to create the document you wish to produce, then save it. Don't create a new page if the SOP already exists! Instead, edit the existing SOP.

Title of Page Must Be Sufficiently Descriptive

1. To create a new page, type the desired page title, using Title Case, into the wiki search box, e.g., "My SOP Name.
2. If the page does not already exist, the search will return 'Create the page "My SOP Name" on this wiki!'. Click the name to create the new page.
3. The new page will open in the editor.
4. At the very top of the page, enter [[Category: SOP]]. Failure to do so will essentially render the SOP invisible as it will not show up in the SOP list. It can then only be found by a search or if the complete page name is known. Note that underscores (_) will replace spaces in the page name.
5. Paste the contents of the clipboard (which you populated with some or all of the contents of this page) using ctrl-v.
6. Edit the new page to include the text and pictures required by your SOP.

Start with Safety

• Really should be called "loss prevention", which is both personal safety and maintaining equipment in a safe, operational condition, i.e. don't break yourself or people around you, and don't break the machine.
• Note even "obvious" safety/loss issues. What is obvious to you may not be to someone else. For example: "Freshly cast parts are HOT when demolded. Handle only with tongs. Never use your hands, even when wearing protective gloves." Or: "Always start moving the machine at a slow speed and ensure no collision will take place before increasing speed."
• Be concise, but complete. Use short sentences. Overlong explanations suffer tl;dr and/or are difficult to understand.

Then the Procedure

1. Break the task into short, logical steps.
2. Use a numbered list indicating the sequence in which steps take place.
3. Create a list item for each step.
4. Write what you would say to someone if you were training them in person.
5. Be concise, descriptive and use short sentences, e.g., "Move the disconnect to the up position until it firmly clicks into place."
6. 

   Make sure the picture is useful.
   Use suitable pictures where appropriate; not every step requires a picture. Highlight portions of the picture to indicate the specific item you are talking about so its location and appearance is clear to the reader.
   • Pictures should support text, not replace text.
   • Add the picture as a thumbnail. The full-size picture is viewable by clicking the thumbnail.
   • The simplest way to add new pictures is to copy/paste an existing picture link while editing, and then changing the filename and caption. Then save changes.
   • The page will then contain a link to upload the new picture.
   • Keep pictures 1024px x 768px or smaller. Resize them before uploading, or you may get an error.
   • The final text in the list item containing the picture should be {{clear}}. This causes the parser to leave white space below the text, making it more clear which step the picture belongs with. Edit this page to see an example.Template:Clear
7. The pursuit of perfection is admirable, but misguided. Do your best to be complete, but consider this is a living document, readily edited as necessary. Focus on loss prevention when preparing your SOP.

If the Task has Subtasks, Use Subheadings

• There may be instances where several tasks, each having multiple steps, are required to complete an overall larger task.
• Break the larger task into subtasks and separate subtasks by placing them under a subheading.
• Heading hierarchy is based on the number of equal (=) signs at the start and end of a line. Click the Edit tab and view the contents of this page for an example.

Formatting Text and Images

• See mediawiki formatting help for detailed formatting information.
• See mediawiki images help for detailed image formatting information.