3 ms·
The thing to learn from this from the opposite side of the fence, i.e. of a developer producing said libraries, is to write good doco: * Write both reference d
by JdeBP 3y ago
The thing to learn from this from the opposite side of the fence, i.e. of a developer producing said libraries, is to write good doco:
* Write both reference doco and guide/tutorial doco. People need both kinds. They should cross reference one another, too.
* Indeed, all of the Five Ws And An H are important. Provide rationales/backgrounders, histories, and even bibliographies where appropriate, too.
* Think about your writing order. Try to make both reference doco and guide doco flow. People do not solely access them piecemeal randomly.
* Read what you have written.
* Remember that doco is for people who don't know stuff. It's not the responsibility of the users to find out, or outright guess at, what your stuff does and then contribute third party doco.
There are lots of other tips for good writing, of course, but these are the ones that seem of particular relevance here.