Workdocumentation 2018-08-27: Difference between revisions

From BITPlan Wiki
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}}")
 
No edit summary
 
(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=http://wiki.bitplan.com/index.php/Workdocumentation_2018-02-21}}
{{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 05:53, 1 September 2018

Add more modules to README Workdocumentation_2018-02-21 Database.svg

Documentation

Each Module documentation should have

  1. Mental Model
  2. Usecase Example
  3. Example Code
  4. Example Result

with cross references between theoretical concepts and the example