Difference between revisions of "StemNode User Manual"

Revision as of 22:42, 28 February 2019

Getting Started Editing

Setting up an Account - Editing requires a user account and login. Use your real first name and surname(s), including spaces, as your username. This ensures that when you edit a review, your name shows up correctly. For example use "John Doe" instead of "johndoe" because you want your name to show up as "John Doe" in the list of authors of a manual.

Editing: Please use the predefined Outline for a Method when making a new method. Copy and paste the source code from the appropriate outline to start;
Mediawiki help pages are available for navigating software features. Most users will prefer to use the visual editor which is similar to using a word processor, however basic formatting code is helpful for advanced users. This manual covers specifically how the mediawiki software is used for stemnode.

Guidelines for Writing Methods

More detail is better. Many sources give methods in brief but this may lead to problems and confusion. We encourage writing methods in procedural form (SOPs) to with detailed steps. It is OK if these steps may not be repeated identically in all labs; the detail will help others adapt methods and save them time.

Equipment can be referenced in general (specific models omitted). Including brands of consumables may be helpful to others to ensure they work with materials that are compatible with reagents.

@@ Line 1: / Line 1: @@
 ===Getting Started Editing===
-'''Setting up an Account''' - Editing requires a user account and login.  This login is separate from your stemnode.org login.  Use your real first name and surname(s), including spaces, as your username. This ensures that when you edit a review, your name shows up correctly. For example use "John Doe" instead of "johndoe" because you want your name to show up as "John Doe" in the list of authors of a manual.
+'''Setting up an Account''' - Editing requires a user account and login.  Use your real first name and surname(s), including spaces, as your username. This ensures that when you edit a review, your name shows up correctly. For example use "John Doe" instead of "johndoe" because you want your name to show up as "John Doe" in the list of authors of a manual.
-'''Do's'''- Use the predefined outlines when making a new method. Copy and paste the source code from the appropriate outline to start;<br/>
-[[Outline for a Technological Process Node]] (for circular nodes)<br/>
-[[Outline for a Natural Process Node]] (for circular nodes)<br/>
-[[Outline for a Storage Node]] (for square nodes)<br/>
-[[Outline for a Flow]] (for both informational and physical flows)<br/>
-All can be changed to use terminology which fits the specific process or flow, however the general format should be adhered to in order to keep a consistent layout of information for all nodes and flows.
+'''Editing:''' Please use the predefined
+[[Outline for a Method]] when making a new method. Copy and paste the source code from the appropriate outline to start;<br />
 Mediawiki help pages are available for navigating software features.  Most users will prefer to use the visual editor which is similar to using a word processor, however [https://www.mediawiki.org/wiki/Help:Formatting basic formatting code] is helpful for advanced users. This manual covers specifically how the mediawiki software is used for stemnode.
-===Guidelines for Writing Reviews===
+===Guidelines for Writing Methods===
--Write at the level appropriate to the associated node(s). Content associated with subsystem nodes should not be duplicated at the parent level node, although brief summaries of the subsystems are typically appropriate. The interaction of two nodes within a system should be covered at the parent level node. Also, makes and models of subsystems should be specified at the parent level node while how the subsystems works should be specified in the relevant subsystem wiki.
+More detail is better.  Many sources give methods in brief but this may lead to problems and confusion.  We encourage writing methods in procedural form (SOPs) to with detailed steps.  It is OK if these steps may not be repeated identically in all labs; the detail will help others adapt methods and save them time.
--Often times reviews should have longer and more detailed titles than the nodes which they link from. This is because the system diagrams have context that imply many things wheras the reviews are out of context and a single review can be linked to multiple nodes. When a succinct name for a process does not exist you should lead the title with it's primary output (e.g. "Yogurt production" has a primary output of "Yogurt"). When a product can be made from different inputs, use the format "[Primary Output] from [Primary Input]" in the name of the review.
--Ensure the reviews can remain relevant to the node(s) they are associated with by keeping content generalized only to the level of that node.  The interaction of two nodes needs to be written about at the review associated with the parent level node.
--Give yourself and other authors credit by including <code><nowiki>{{Template:CiteAuthors}}</nowiki></code> as the top line in the source code of each review.
+Equipment can be referenced in general (specific models omitted).  Including brands of consumables may be helpful to others to ensure they work with materials that are compatible with reagents.