Style guides for software documentation

If you are a software developer, and if you need to write an online help system, reference manual, or user guide, where do you start? We recommend these style guides as a starting point:

Other excellent books are available, but they are designed for professional technical communicators. We think that the style guides in the list are the most suitable for people who are not professional technical communicators, but who need to produce software user documentation as part of their work.

General style guides

For technical writing in general, a good free download is NASA SP-7084 Grammar, Punctuation, and Capitalization (http://stipo.larc.nasa.gov/sp7084/). The document was written for technical editors, so it may be heavy going for people who are not in the profession.

For excellent general advice, see:

See also

Language style guide for software developers

Standards and guidelines

Publicly available IT standards (free download, http://isotc.iso.org/livelink/livelink/fetch/2000/2489/Ittf_Home/PubliclyAvailableStandards.htm)

RSS feed