Please enable JavaScript.
Coggle requires JavaScript to display documents.
Documentation - Coggle Diagram
Documentation
How?
Describes how the code does it and now what
Using tools
Doxygen
Ghost doc
Java Doc
Docurium
Keep it simple and concise
Do not repeat yourself (DRY)
Keep it up to date
Document any change
Use simple common language
English
2nd person
Active voise
Present tense
Why?
Code must be readable
Code is shared across several people
Code might be confusing
Helps to troulblehsoot production issues
Helps to handle better product add ons