Documentation Skills

Question

I am a .net developer with more than 8 years of experience. But I suck when it comes to documentation. How do I improve my documentation skills as a .net developer.

Any resources would definately help.

Thanks

Answer 1

To start with, I'd suggest studying The Elements of Style, and always keep the perspective of your audience in mind while writing. Write about what is interesting to them, not what is interesting to you. Keep things brief and to the point. Long winded explanations do not get bonus points and are only more likely to confuse the reader.

I am sure there are many more sources worthy of study, but that is at least a place to start.

Answer 2

Copy the writing style and layout of existing documentation that you have found particularly helpful. For example, if you find the Microsoft style of API doumentation helpful, style your own API documentation in the same way.