Use cases¶
Dev Ops¶
Document your build scripts thoroughly. This is very useful for setting up small system or learning *nix.
Students / Data Scientists¶
Document all your research material easily. If you use Tex, you could probably write your Phd thesis in this approach.
Todo
Create a usable example for a latex thesis
Standards¶
Documenting standards and test cases can be made quite elegant with this approach.
Linux Users¶
Document your config files.
Bloggers / Writers¶
Todo
Create a usable example for jekyll
While embedding codepen is popular, things quickly go out of sync. You can avoid that.
If you are trying to write books too you could give this tool a shot. I believe the following books used similar approaches,
https://github.com/progit/progit2
https://github.com/bslatkin/effectivepython
Designer / Startup / Game Developer¶
Prominent games already use a [https://en.wikipedia.org/wiki/Game_design_document]. Sphinx is an excellent for such documentation. Linking executable code, design assets can only enrich the documentation. You can use this setup to document all major design and marketing decisions.
This document can act as the big picture on which everyone can collaborate together. It brings clarity.
https://www.gamasutra.com/view/feature/3384/the_anatomy_of_a_design_document_.php
https://github.com/Roobyx/awesome-game-design
https://gamedocs.org/documents/
https://en.wikipedia.org/wiki/Systems_development_life_cycle
Programmers / Open Source developers¶
Every codebase becomes unreadable after a while because much of the initial context is lost. Literate programming can completely fix this.
Literate programming might not be scalable for large teams without requiring a radical change but for open source developers and small teams I think its a huge value add. A lot of programmers have built complex reliable systems in tiny teams till the early 90s. Good documentation can make or kill your project.
https://github.com/PharkMillups/beautiful-docs
https://open.nytimes.com/how-to-take-your-open-source-project-from-good-to-great-49c392175e5cA
https://en.wikipedia.org/wiki/Structured_systems_analysis_and_design_method