3 ms·
> How do I get better at writing documentation? Read other documentation. Discover what choices the writers made (implictly) and what works for you w.r.t. stru
by jschulenklopper 12y ago
> How do I get better at writing documentation?
Read other documentation. Discover what choices the writers made (implictly) and what works for you w.r.t. structure, clarity, completeness, conciseness. In your case, look for documentation of other (web) frameworks with a large audience, for example:
- Django: https://docs.djangoproject.com/en/1.7/ https://docs.djangoproject.com/en/1.7/
- Symfony: http://symfony.com/doc/current/book/index.html http://symfony.com/doc/current/book/index.html
- Rails: http://guides.rubyonrails.org/ http://guides.rubyonrails.org/ and http://api.rubyonrails.org/ http://api.rubyonrails.org/