Live data from Hacker News

Ask HN: Any great books about technical writing?

news.ycombinator.com

51–60 of 87 posts

Re: Ask HN: Any great books about technical writing?

#52
I don't know of any "how to write tech. books" kinds of books. I do have some recommendations of good examples of technical writing and right on top of the list is the C programming language closely followed by anything written by Brian Kernighan. The latters relaxed presentation with hard hitting examples drives home points in a way that no other book I've read does.

Re: Ask HN: Any great books about technical writing?

#55
I'm a Director of Software Engineering today, but early in my career I was a technical writer.

The #1 most important thing imho is know your audience. Who are you writing for? What do you know about them, or what can you reasonably successfully guess about them?

I once wrote a suite of manuals (yes, I'm that old) for an ERP software product. The audience was people on manufacturing shop floors, AP and AR people, sales people -- in other words, people who didn't know and didn't care about the underlying tech. They just wanted instructions to do their tasks. I learned their lingo and used it, and otherwise tried to write on a fourth-grade level.

At another company we wrote documentation that techs at wireline telephone companies used to install and operate our software. While these people weren't software developers, they were technical people and I wrote to them as such. I gave them the theory and concept behind things as well as the task instructions they needed.

Re: Ask HN: Any great books about technical writing?

#60
David Beer & David McMurrey, A Guide to Writing as an Engineer http://www.worldcat.org/oclc/1103219505

Philip Kiely, Writing for Software Developers https://philipkiely.com/wfsd/

Michael Alley The Craft of Scientific Writing http://www.worldcat.org/oclc/1032304610

Also see Online Technical Writing https://mcmassociates.io/textbook/ David McMurrey

Post reply on HN