Why Documentation is needed?¶
- Reuse the existing source code
- Research implementation
- Tool development
- Manual of software
- ex) Nakid, Mohm&Naht, ...
How about common word processor?¶
- Text editor, Word, Google docs, Latex...
- Bothersome works to update separately(Editing code / Adding some functions / ...)
- Tired to make a nice design
How to solve this problem?¶
- Automatic documentation
- Annotate on the source code
- Generate document based on the annotations
- When the source code changed, the document updated automatically
- Nice and various document themes
- On-line platform to generate documentation
- On-line source code repository
- Update/build document in on-line platform
- Easy to access anywhere