Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Problem with documentation is that there are a lot of uses for documentation. It can be a reference, it can describe the architecture, it can do many things. Probably a good idea to figure out what the intent is first to find a good form.

Some of my stuff is pretty sprawling, I've started integrating the documentation with the code and basically use readme.md's littered in the code as sign-posts to let you navigate it more quickly. The intent of that documentation is pretty clear, and the shape follows logically.

e.g. https://github.com/MarginaliaSearch/MarginaliaSearch/tree/ma...



Hesitant though I am to recommend an approach to structuring documentation which needs its own documentation, the structure followed by the Django docs is straightforward to apply: https://mattsegal.dev/how-to-read-django-docs.html




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: