Difference between revisions of "Outline for Lab Equipment Manual"
From StemNode Lit Reviews
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
The goal of this outline is to standardize the communication of scientific and technical information. Try to follow the spirit of the outline but delete irrelevant sections and alter as needed. If information for a section is not available at the time of page creation, but the section is still relevant, keep the section to indicate the opportunity to contribute to others. Additional guidance is provided in comments that only appear in the source code. | The goal of this outline is to standardize the communication of scientific and technical information. Try to follow the spirit of the outline but delete irrelevant sections and alter as needed. If information for a section is not available at the time of page creation, but the section is still relevant, keep the section to indicate the opportunity to contribute to others. Additional guidance is provided in comments that only appear in the source code. | ||
| − | + | Click "Edit Source" above, then copy and paste the text below the dotted line to start a page for a process node. | |
---------- | ---------- | ||
<!-- This shows the authors that have edited a page and gives them credit for their contribution --> | <!-- This shows the authors that have edited a page and gives them credit for their contribution --> | ||
| Line 13: | Line 13: | ||
== Operation == | == Operation == | ||
| − | == | + | === Operating Procedures === |
| − | == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Troubleshooting === | ===Troubleshooting === | ||
| Line 39: | Line 23: | ||
! Problem | ! Problem | ||
! Symptom (s) | ! Symptom (s) | ||
| − | ! Fundamental Cause | + | ! Fundamental Cause(s) |
| − | ! Solution | + | ! Solution(s) |
|- | |- | ||
| Line 49: | Line 33: | ||
|} | |} | ||
| − | === | + | ==Maintenance == |
| − | + | ===Maintenance Schedule=== | |
| − | = | + | <!--This section is for expected maintenance. Repairs of unexpected problems should go under the "Typical Failures and Known Solutions" section. Cost data should be omitted since it will change over time--> |
| − | <!-- | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | <!--This table is generally only appropriate for specific systems (manuals on a specific make and model). Consider omitting for generalized systems--> | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| − | ! | + | !Action |
| − | ! | + | ! Frequency |
| − | ! | + | ! Who Performs? |
| − | ! | + | ! Time to Complete |
| − | |||
|- | |- | ||
| − | + | | | |
| − | | | + | | (state the frequency) |
| − | | ( | + | | (User, Professional, Manufacturer, Anyone) |
| − | + | | (Number and unit of time) | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | ( | ||
|} | |} | ||
| − | === | + | ==Repair == |
| − | |||
| − | |||
| − | |||
| − | = | + | == Safety ==<!--Personal protective equipment, or operating requirements --> |
| − | = | ||
| − | + | == Versions of the System ==<!--This only applies to specialized systems (those that have a make, model that have specific systems within them. Delete section for specific systems --> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | ==Versions of the System== | ||
| − | <!--This only applies to specialized systems (those that have a make, model that have specific systems within them. Delete section for specific systems --> | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 145: | Line 69: | ||
| (State a Date) | | (State a Date) | ||
| (State a unitless quantity) | | (State a unitless quantity) | ||
| − | |} | + | |}<!-- Only briefly state anything that the StemNode Diagrams can cover as inputs. Use metric base units (Kg, L, m, A, cd, mol) where practical, with the exception of temperature which should be in Celsius instead of Kelvin. Chemical and biochemical processes should be in molar ratios.--> |
| + | === Accessories, Modifications, Hacks === | ||
| − | == | + | ==Diagrams== |
| − | <!-- | + | <!--Insert images or link to CAD, PDF, image and vector files, or other visual models that host the files. This section is often only useful for specific systems (manuals on a specific make and model). Use [http://www.example.com link title], and replace "link title" with the desired text to appear --> |
| − | == | + | ==Warranties== |
| − | <!-- | + | <!--This only applies to specific systems (manuals on a specific make, model, or serial number). Delete section for generalized systems --> |
| − | == | + | == Certifications and Training == |
| − | |||
| − | |||
==Manufacturer Information== | ==Manufacturer Information== | ||
Latest revision as of 04:53, 5 March 2019
The goal of this outline is to standardize the communication of scientific and technical information. Try to follow the spirit of the outline but delete irrelevant sections and alter as needed. If information for a section is not available at the time of page creation, but the section is still relevant, keep the section to indicate the opportunity to contribute to others. Additional guidance is provided in comments that only appear in the source code.
Click "Edit Source" above, then copy and paste the text below the dotted line to start a page for a process node.
Authors:
This system is also called: Keywords:
Contents
Operation
Operating Procedures
Troubleshooting
| Problem | Symptom (s) | Fundamental Cause(s) | Solution(s) |
|---|---|---|---|
| A goal the user cannot achieve | Usually a measurable or observable attribute | Connect to a more fundamental principle | Action that can be taken |
Maintenance
Maintenance Schedule
| Action | Frequency | Who Performs? | Time to Complete |
|---|---|---|---|
| (state the frequency) | (User, Professional, Manufacturer, Anyone) | (Number and unit of time) |
Repair
Safety
Versions of the System
| Version | Dates of Production | End of Production | Number Produced |
|---|---|---|---|
| (Insert Version) | (State a Date) | (State a Date) | (State a unitless quantity) |
