DEV Community

Discussion on: How do you document your side projects?

Collapse
 
patarapolw profile image
Pacharapol Withayasakpunt • Edited

The idea of doctest borrowed from Python, is helpful to both documenting examples, and up-to-date testing.

I have seen documentation websites generated automatically from JSDoc or JavaDoc as well, but I don't think they are always well-tuned. A better way still remains to be manually writing them.

About how to do open-source projects well, I am learning from opensource.guide/

Collapse
 
alexandrshy profile image
Alex Shulaev

This guide looks very interesting, today after work I'll definitely read it, thanks!