Changes between Version 15 and Version 16 of GeniExperiments
- Timestamp:
- 01/18/13 17:32:21 (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
GeniExperiments
v15 v16 88 88 e) Each step typically includes these items: 89 89 90 + Goal for this step91 92 + Configuration for this step93 94 + Sub-steps, numbered 1 - n90 + Goal, for this step 91 92 + Configuration, for this step 93 94 + Sub-steps, numbered 1 - 9 95 95 96 96 + Optional sub-sub-steps, identified a - z … … 106 106 f) This is consistent with a "best-in-class" example: web page [http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html Getting Started with Amazon EC2 Linux Instances] 107 107 108 g) The following may also be included in the workflow, at the top level or within a step: 109 110 + FAQs 111 112 + Troubleshooting info 113 114 + Refrences 108 115 109 116 == 6) Current Mapping from Basic GENI Experiment/Tutorial Workflow to Experiment Management Tools (Jeanne) == … … 130 137 f) Number the steps for easy reference; follow the approach in the Amazon table: steps 1 - 9; within a step, sub-steps 1 - 9; optionally, within a sub-step, sub-sub-steps a - z 131 138 132 g) 139 g) Each step should be phrased: "do this.."; consider a controlled vocabulary, such as: use; do; repeat; stop; load; execute; see; expect 140 141 h) Each step should be indented, so that the user can check off the steps on the left, when the web page is printed. 142 143 i) Additional notes can be included, with a different identation than the steps, to provide notes to the user 144 145 j) Notes to the user may include: tips; FAQs; troubleshooting info; references 146 147 j) The configuration in a step should include a figure 148 149 k) When a selection or command entry is required, a box should be used to show the related command line, GUI entry and/or script 150 151 l) When a selection is required by the user, it shoudl be clear what they are to enter 152 153 m) Expected results should be presented, typically with a box that shows the related command line, GUI entry and/or script 154 155 n) 133 156 134 157 == 8) Example Tutorials (Jeanne and Harry) ==