3 ms·
I think the important question to answer is actually why should you produce good docs. Is it to inboard new devs quicker? To help experienced devs find informat
by onion2k 7y ago
I think the important question to answer is actually why should you produce good docs. Is it to inboard new devs quicker? To help experienced devs find information faster? To act as a first line of support to reduce questions from third parties using your API? Maybe a bit of everything?
It'll vary from project to project depending on the audience. There's no such thing as definitively "good docs" that would work for everyone, but you certainly can make good docs for a given project if you know what your audience needs. Ask that question first.
- JadeNB 7y ago> I think the important question to answer is actually why should you produce good docs. I know it's not quite your point, but the article http://stevelosh.com/blog/2013/09/teach-dont-tell http://stevelosh.com/blog/2013/09/teach-dont-tell linked elsewhere (https://news.ycombinator.com/item?id=21339009 https://news.ycombinator.com/item?id=21339009) proposes: > The purpose of technical documentation is to take someone who has never seen your project, teach them to be an expert user of it, and support them once they become an expert.