Changes between Initial Version and Version 1 of workbench_documentation_template

Timestamp:

02/19/08 18:49:37 (17 years ago)

Author:

gkronber

Comment:

copied page from private trac

workbench_documentation_template

@@ +1 @@
+Copy the text in this box
+{{{
+= Title =
+== Description ==
+Provide here the purpose and/or idea of this workbench
+
+== Parameters ==
+  * Problem
+    * Setting = value
+  * Algorithm
+    * Setting = value
+    * ...
+
+== Implementation & Notes ==
+If you know it, please specify the revision of the repository which was used to build the framework and algorithm using the r + revision number syntax and any tickets using the # + ticket number syntax which are related to the workbench.
+Additionally write notes regarding the parameters or give implementation specific details
+
+== Results & Conclusions ==
+Results from one or more testruns
+
+== Files ==
+Link to the workbench and any other files in the repository which you want included here
+----
+}}}
+
+This will look like following:
+= Title =
+== Description ==
+Provide here the purpose and/or idea of this workbench
+
+== Parameters ==
+ * Problem
+    * Setting = value
+ * Algorithm
+    * Setting = value
+    * Setting:
+      * Subsetting = value
+      * ...
+    * ...
+
+== Implementation & Notes ==
+If you know it, please specify the revision of the repository which was used to build the framework and algorithm using the r + revision number syntax and any tickets using the # + ticket number syntax which are related to the workbench.
+Additionally write notes regarding the parameters or give implementation specific details
+
+== Results & Conclusions ==
+Results from one or more testruns
+
+== Files ==
+Link to the workbench and any other files in the repository which you want included here
+----