Difference between revisions of "Outline for a Technological Process Node"

From StemNode Lit Reviews
m
 
(63 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 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 to others an opportunity to contribute. 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.   
 
Click "Edit Source" above, then copy and paste the text below the dotted line to start a page for a process node.   
Line 7: Line 7:
 
{{Template:CiteAuthors}}
 
{{Template:CiteAuthors}}
  
−
=Theory of Operation=
+
'''This system is also called:'''
 +
'''Keywords:'''
 +
 
 +
=Significance=
 +
<!--Relay any broader impact.  Typically for generalized systems (systems that do not have a specific make and model)-->
 +
 
 +
=Principles of Operation=
 
<!-- Only briefly state anything that the StemNode Diagrams can cover within subsystems.  This section is often omitted for specific systems (manuals on a specific make, model, or serial number) -->
 
<!-- Only briefly state anything that the StemNode Diagrams can cover within subsystems.  This section is often omitted for specific systems (manuals on a specific make, model, or serial number) -->
  
−
==Operating Requirements and Conditions==
+
==Modes of Operation==
−
<!-- Only briefly state anything that the StemNode Diagrams can cover as inputs. -->
+
<!-- Make each mode a subheader if additional information is presented on the mode.  Many generalized systems are operated in different modes; for example a tractor can be operated in tiller, backhoe, fork lift, mower, or shovel loader modes. This section helps reduce the need for replicating system pages when it is used under different situations.-->
 +
 
 +
==Operating Specifications==
 +
===Operating Parameters and Limitations===
 +
<!-- Typically used for specific systems (ones that have a make and model) -->
 +
 
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
! Condition
+
! rowspan ="2"|Parameter
−
! Optimum
+
! colspan = "3"|Optimum
−
! Range
+
! rowspan ="2"|Operating Range
−
! Unit
+
! rowspan ="2"|Units
−
 
+
! rowspan ="2"|Effect on Outputs
 +
|-
 +
!(e.g. Mode 1) !! (e.g Mode 2) !! (e.g. Mode 3)
 
|-
 
|-
 
| (e.g. Temperature)
 
| (e.g. Temperature)
−
| (e.g. 50)
+
| style="text-align:right;"| (Mode 1 Optimum)
−
| (e.g. 40)
+
| style="text-align:right;"| (Mode 2 Optimum)
 +
| style="text-align:right;"| (Mode 3 Optimum)  
 +
| style="text-align:right;"| (e.g. 40-70)
 
| (e.g °C)
 
| (e.g °C)
 +
| (notes)
 +
|-
 +
| (e.g. pH)
 +
| colspan = "3" style="text-align:center;" | (e.g. 7)
 +
| style="text-align:right;"| (e.g. 6.5-8.5)
 +
| -
 +
| (notes)
 
|}
 
|}
  
−
==Ratios of Inputs to Outputs==
+
===Requirements for Operation===
−
<!--Use metric base units (Kg, L, m, A, cd, mol) where practical, with the exception of temperature which should be in Celcius instead of Kelvin. Chemical and biochemical processes should be in molar ratios. Alternate units can be placed in parentheses -->
+
<!-- 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.-->
 +
 
 +
===Correlation of Inputs to Outputs===
 +
<!--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. Alternate units can be placed in parentheses -->
 +
 
 +
==Mathematical Models==
 +
<!-- Alternatively "Mathematical Models". Link to code sets, MatLab models ect. hosted on external websites.  Use [http://www.example.com link title], and replace "link title" with the desired text to appear -->
 +
 
 +
=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 -->
  
−
==Computational Models==
 
−
<!-- Link to code sets, MatLab models ect. hosted on external websites.  Use [http://www.example.com link title], and replace "link title" with the desired text to appear -->
 
  
−
==States of System==
+
=Commissioning=
−
<!-- Alternative names for this section are "Modes of System" -->
+
 
 +
 
 +
=Best Practices=
  
 
=Maintenance and Repair=
 
=Maintenance and Repair=
−
 
+
==Monitoring==
 
==Maintenance Schedule==
 
==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 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"
Line 48: Line 81:
 
! Time to Complete
 
! Time to Complete
 
|-
 
|-
−
| state the frequency
+
| (state the frequency)
−
| state the action
+
| (state the action)
−
| User, Professional, Manufacturer, Anyone
+
| (User, Professional, Manufacturer, Anyone)
−
| Number and unit of time
+
| (Number and unit of time)
 
|}
 
|}
  
−
==Failures and Known Solutions==
+
==Known Failures and Solutions==
−
<!--Historical significance of a failure is better suited for Wikipedia or other sites.  You are encouraged to link out to these sites from this section -->  
+
<!--Historical significance of a failure is better suited for Wikipedia or other sites.  You are encouraged to link out to these sites from this section.  -->
 +
 
 +
<!--Problems are user oriented since a problem to one entity may not be a problem to another, Symptoms are an observable, and sometimes measurable trait, Fundamental causes connect the problem with subsystems or symptoms, and Solutions are actions that can be taken to remedy the problem -->
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
! Symptom(s)
+
! Problem
−
! Cause
+
! Symptom (s)
 +
! Fundamental Cause
 
! Solution
 
! Solution
  
 
|-
 
|-
−
| State the Symptom
+
| A goal the user cannot achieve
−
| State the Cause
+
| Usually a measurable or observable attribute
−
| State the Solution
+
| Connect to a more fundamental principle
 +
| Action that can be taken
 
|}
 
|}
  
−
==Warranty==
+
==Warranties==
 
<!--This only applies to specific systems (manuals on a specific make, model, or serial number).  Delete section for generalized systems -->
 
<!--This only applies to specific systems (manuals on a specific make, model, or serial number).  Delete section for generalized systems -->
  
−
=Instances of the System=
+
=End of Life=
−
<!--This only applies to generalized systems (those that do not have a make, model, or serial number).  Delete section for specific systems -->
+
 
 +
=System Variations=
 +
<!--Discuss Variations, Modifications, or hacks on the System -->
 +
 
 +
==Upgrades, Modifications, Hacks==
 +
 
 +
==Systems Instances==
 +
<!--This only applies to generalized systems (those that do not have a make, model, or serial number) that have specific systems within them.  Delete section for specific systems -->
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
Line 79: Line 123:
 
! Make
 
! Make
 
! Model
 
! Model
−
! Start of Production
+
! Dates of Production
 
! End of Production  
 
! End of Production  
 
! Number Produced
 
! Number Produced
  
 
|-
 
|-
−
| State the Company
+
| (Insert Company)
−
| State the Model
+
| (Insert Model)
−
| State a Date
+
| (State a Date)
−
| State a unitless quantity
+
| (State a Date)
 +
| (State a unitless quantity)
 
|}
 
|}
  
−
=System Modifications=
+
{| class="wikitable sortable"
−
<!--Discuss Variations on the System.  Typically these are not Manufacturer Sanctioned and therefor they apply only to specific systems (manuals on a specific make or model) -->
+
|-
 +
! Location
 +
! Date Installed
 +
! Owner/Operator
 +
|-
 +
|
 +
|
 +
|
 +
|}
  
−
=2D and 3D models=
+
==Case Studies==
−
<!-- This section is often only useful for specific systems (manuals on a specific make and model) Link to CAD drawings, PDFs ect on external websites that host the files.  Use [http://www.example.com link title], and replace "link title" with the desired text to appear -->
+
 
 +
==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"
 +
|-
 +
! Version
 +
! Dates of Production
 +
! End of Production
 +
! Number Produced
 +
 
 +
|-
 +
| (Insert Version)
 +
| (State a Date)
 +
| (State a Date)
 +
| (State a unitless quantity)
 +
|}
 +
 
 +
=Safety=
 +
<!--Personal protective equipment, or operating requirements -->
 +
 
 +
=Cultural Considerations=
 +
<!--An opportunity to give credit to entire cultures when an individual cannot be credited, and/or relay ethnological significance -->
  
 
=Intellectual Property=
 
=Intellectual Property=
 
<!-- List any relevant patents, copyrights, or trade secrets on the system -->
 
<!-- List any relevant patents, copyrights, or trade secrets on the system -->
  
−
=Regulations=
+
=Policies=
 
<!-- Subsections should be organized in alphabetical order by country, then state, where the regulations apply -->
 
<!-- Subsections should be organized in alphabetical order by country, then state, where the regulations apply -->
 +
 +
=Cost Data=
 +
 +
=Manufacturer Information=

Latest revision as of 02:10, 29 December 2018

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:

Significance

Principles of Operation

Modes of Operation

Operating Specifications

Operating Parameters and Limitations

Parameter Optimum Operating Range Units Effect on Outputs
(e.g. Mode 1) (e.g Mode 2) (e.g. Mode 3)
(e.g. Temperature) (Mode 1 Optimum) (Mode 2 Optimum) (Mode 3 Optimum) (e.g. 40-70) (e.g °C) (notes)
(e.g. pH) (e.g. 7) (e.g. 6.5-8.5) - (notes)

Requirements for Operation

Correlation of Inputs to Outputs

Mathematical Models

Diagrams

Commissioning

Best Practices

Maintenance and Repair

Monitoring

Maintenance Schedule

Frequency Action Who Performs? Time to Complete
(state the frequency) (state the action) (User, Professional, Manufacturer, Anyone) (Number and unit of time)

Known Failures and Solutions

Problem Symptom (s) Fundamental Cause Solution
A goal the user cannot achieve Usually a measurable or observable attribute Connect to a more fundamental principle Action that can be taken

Warranties

End of Life

System Variations

Upgrades, Modifications, Hacks

Systems Instances

Make Model Dates of Production End of Production Number Produced
(Insert Company) (Insert Model) (State a Date) (State a Date) (State a unitless quantity)
Location Date Installed Owner/Operator

Case Studies

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)

Safety

Cultural Considerations

Intellectual Property

Policies

Cost Data

Manufacturer Information

Retrieved from "https://wiki.stemnode.org/index.php?title=Outline_for_a_Technological_Process_Node&oldid=612"
Powered by MediaWiki