6 ms·
Can anyone look to good guides / examples on technical writing [for those of us who are developers who have to also write docs from time to time]
by smiler 14y ago
Can anyone look to good guides / examples on technical writing [for those of us who are developers who have to also write docs from time to time]
- macintux 14y agoMark Phillips' beautiful docs list: https://github.com/PharkMillups/beautiful-docs https://github.com/PharkMillups/beautiful-docs
- aslewofmice 14y agoCheck out https://readthedocs.org/ https://readthedocs.org/ which is directly related to writethedocs.org. Here's a bit more instruction on how they're building up a repository of these docs: https://docs.readthedocs.org/en/latest/index.html https://docs.readthedocs.org/en/latest/index.html
- forsaken 14y agoWe're also trying to build a resource around this kind of information on docs.writethedocs.org. It just launched today as part of this, and is half baked. However, this is the start of that doc: http://docs.writethedocs.org/en/latest/starting.html http://docs.writethedocs.org/en/latest/starting.html It isn't so much about how to write documentation, but adding that section is something we want to do. We also have a section currently linked to a couple of interesting projects: http://docs.writethedocs.org/en/latest/about/alternatives.html#interesting-approaches-to-documentation http://docs.writethedocs.org/en/latest/about/alternatives.ht...