StemNode User Manual - Revision history

Raymond RedCorn at 04:03, 6 March 2019

2019-03-06T04:03:28Z

Raymond RedCorn at 22:42, 28 February 2019

2019-02-28T22:42:41Z

Raymond RedCorn at 04:26, 28 February 2019

2019-02-28T04:26:56Z

Raymond RedCorn: /* Guidelines for Writing Reviews */

2018-11-29T08:53:45Z

Guidelines for Writing Reviews

Raymond RedCorn: /* Guidelines for Building System Maps */

2018-11-09T13:53:36Z

Guidelines for Building System Maps

Raymond RedCorn: /* Guidelines for Building System Maps */

2018-11-09T13:53:06Z

Guidelines for Building System Maps

Raymond RedCorn: /* stemnode.org */

2018-11-09T13:24:15Z

stemnode.org

Raymond RedCorn: Raymond RedCorn moved page User Manual to StemNode User Manual

2018-11-07T15:06:58Z

Raymond RedCorn moved page User Manual to StemNode User Manual

Raymond RedCorn: /* Getting Started Editing */

2018-11-07T15:06:15Z

Getting Started Editing

Raymond RedCorn: /* Guidelines for Building System Maps */

2018-11-07T15:05:30Z

Guidelines for Building System Maps

@@ Line 1: / Line 1: @@
-===Getting Started Editing===
+==Getting Started==
-'''Editing:''' Please use the predefined
+=== Setting up an Account ===
-[[Outline for a Method]] when making a new method. Copy and paste the source code from the appropriate outline to start;<br />
+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.
-===Guidelines for Writing Methods===
+=== Starting a New Manual ===
-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.
+At the upper right of the page you can for the piece of equipment or method you are looking for.  For equipment search "[Model] - [Manufacturer]".  If the equipment page does not exist then you will see the option to "Create" the page above the search results.  Click the "Create - [Model]-[Manufacturer]" option (It important that you search by "[Model]-[Manufacturer]" so that the pages are titled according to that standard). You will be taken to a page to edit the source code.  In a separate tab, go open the [[Outline for Lab Equipment Manual]] (or [[Outline for a Method]] if appropriate) , click "View Source" and copy and paste the source code into the new page you are creating.  This provides tables and an outline structure to get started, as well as ensures that you are credited as an author on the manual. Clicking "Create" at the top of the page then takes you from the source code to a visual editor that is much more similar to a word processor.
-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.
+== Guidelines for Writing Equipment Manuals and Methods ==

@@ 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.
 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.
--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.

@@ 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.
-'''Do's'''- Use the predefined outlines when making a new manual on an object in a system. Copy and paste the source code from the appropriate outline to start;<br/>
+'''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/>
@@ Line 42: / Line 10: @@
 [[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.
 ===Guidelines for Writing Reviews===

@@ Line 44: / Line 44: @@
 ===Guidelines for Writing Reviews===
--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.
+-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.
 -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.

@@ Line 18: / Line 18: @@
 '''Do's and Don'ts'''
 -Do build generalized system maps that fit a generalized purpose, but do not attempt to represent every potential configuration of that system in a single diagram.  Instead place each practical configuration in a separate node so that others can use that configuration in other systems.
 -Do map specific systems; maps of systems that actually exist at a specific location (even if that location may move in time).  These often serve as case studies that others can learn from.
 -Do build system maps of theoretical systems that could be possible in the future but are not yet built, as long as they serve a function or improvement for society.
 -Do use a node to hold nodes that are all the same type of system, or components in the same category of systems (e.g. Building Scale Wastewater Treatment Systems, Electrical Components), however do not try to connect nodes with flows because you often end up with messy diagrams where many combinations of subsystems are possible.
 -It is typically appropriate to name ports the same as the external flow that connects to it.  When two or more different flows connect to it use more generic terminology which describes all the connecting flows succinctly (e.g. if both starch and sucrose are input flows to a port, then "carbohydrates" may be an appropriate name for the port).  Alternatively, use terminology for the connection point itself (e.g. a "terminal" on a battery, or a "Universal Serial Bus (USB)" port on a computing system).
 -Do not title flows with verbs or actions.  Names of flows should typically be nouns although adjectives may also be appropriate to include.

← Older revision		Revision as of 13:24, 9 November 2018
Line 1:		Line 1:

−	==~~stemnode~~.org==	+	==Stemnode.org==
	Stemnode.org consists of systems of systems maps.		Stemnode.org consists of systems of systems maps.

← Older revision	Revision as of 15:06, 7 November 2018
(No difference)

@@ Line 20: / Line 20: @@
 '''Don'ts'''
-- Do not tile flows with verbs or actions.  Names of flows should typically be nouns although adjectives may also be appropriate to include.
+- Do not title flows with verbs or actions.  Names of flows should typically be nouns although adjectives may also be appropriate to include.
 ==Wiki.stemnode.org==