Ask HN: Any great books about technical writing?
51–60 of 87 posts
Re: Ask HN: Any great books about technical writing?
#52Re: Ask HN: Any great books about technical writing?
#53Re: Ask HN: Any great books about technical writing?
#54Re: Ask HN: Any great books about technical writing?
#55The #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?
#56Strunk & White's The Elements of Style is a classic.
Re: Ask HN: Any great books about technical writing?
#57https://www.amazon.com/Letting-Go-Words-Interactive-Technolo...
It is practical guidance that is durable over time. The book is exemplary of the advice on the pages. Plain language FTW!
Re: Ask HN: Any great books about technical writing?
#58Re: Ask HN: Any great books about technical writing?
#59Re: Ask HN: Any great books about technical writing?
#60Philip 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