Difference between revisions of "Workdocumentation 2018-08-27"
Jump to navigation
Jump to search
(Created page with "Add more modules to README {{Link|target=http://wiki.bitplan.com/index.php/Workdocumentation_2018-02-21}}") |
|||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | {{WorkSequence|prev=2018-08-20|next=2018-09-01}} | ||
Add more modules to README | Add more modules to README | ||
− | {{Link|target= | + | {{Link|target=Workdocumentation_2018-02-21}} |
+ | [[File:Database.svg|114px]] | ||
+ | |||
+ | = Documentation = | ||
+ | Each Module documentation should have | ||
+ | # Mental Model | ||
+ | # Usecase Example | ||
+ | # Example Code | ||
+ | # Example Result | ||
+ | |||
+ | with cross references between theoretical concepts and the example |
Latest revision as of 06:53, 1 September 2018
Add more modules to README Workdocumentation_2018-02-21
Documentation
Each Module documentation should have
- Mental Model
- Usecase Example
- Example Code
- Example Result
with cross references between theoretical concepts and the example