Is there any good book/tutorial/guide for programmers, which can help them to write good programming documentation/tutorials/guides?
- Anybody can ask a question
- Anybody can answer
- The best answers are voted up and rise to the top
closed as not a real question by Walter, Yusubov, gnat, Robert Harvey, Yannis♦ Nov 5 '12 at 23:22
It's difficult to tell what is being asked here. This question is ambiguous, vague, incomplete, overly broad, or rhetorical and cannot be reasonably answered in its current form. For help clarifying this question so that it can be reopened, visit the help center.If this question can be reworded to fit the rules in the help center, please edit the question.
My advice is to look at tutorials that you consider good and copy their style.
Some things that generally improve documentation:
I've been doing programming docs for about 25 years, from the Unix Programmer's Manual to Microsoft server apps. Technical documentation has a pyramid of priorities:
When possible, provide examples. In many cases, a developer will take a decent example and run with it.
Technical docs are written in the reverse order in which they typically appear. You usually write the reference section first, then a guide/cookbook section, then an introduction, and finally a tutorial if you have time.
And don't forget a good editor. Much as a developer should not test and verify his own code, you should not edit your own docs.
Almost all decent-sized companies have a document style guide. I even have an old AP Style Guide text from the university days. Read Strunk and White.
You might even look into some community college courses. Like non-developers who do not code, non-writers have no idea how hard it is to write decent developer documentation. If you've ever stared at code you wrote 3 months ago and cannot figure out what the heck you were thinking, imagine trying to document code from someone who is no longer with the company. It's more challenging than writing the code in the first place.
Be careful about humor. Depending upon your abilities, it can been misunderstood. I don't recommend it. As far as good documentation being found in a forum where anyone can change it, good luck with keeping the spammers out.