What do you think?
Rate this book
Modern Technical Writing: An Introduction to Software Documentation
This slender volume provides the foundational knowledge to start creating and publishing great software documentation. Written by the lead technical writer at one of Silicon Valley's most exciting companies, Modern Technical Writing is a set of guiding principles and thoughtful recommendations for new and experienced technical writers alike. Not a reference manual, and not comprehensive, it instead serves as an introduction to a sensible writing and publishing process, one that has eluded the profession for too long.
52 pages, Kindle Edition
Published January 2, 2016
151 people are currently reading
347 people want to read
Ratings & Reviews
Friends & Following
Create a free account to discover what your friends think of this book!
Community Reviews
Displaying 1 - 30 of 38 reviews
January 17, 2020
I feel as if Etter thinks publishing is the sole job of a tech writer.
I loved the part where Etter lays out the key, fundamental questions a tech writer should ask when writing documentation. I want to print them out on index cards and post them around my monitor.
Outside of those questions, this book was all about the tooling. Not about content architecture, findability, not even about the usability and usefulness that he says tech writing is all about. For example, Etter says tech writers should use analytics to see if their docs are useful. And then he hops to saying that Google Analytics is THE TOOL to use. And that was it. No discussion on what sorts of metrics may be useful, how to maybe think about those metrics, etc. IT'S ALL ABOUT THE TOOLS, FOLKS. I'll definitely revisit this book when I need to evaluate tools.
I loved the part where Etter lays out the key, fundamental questions a tech writer should ask when writing documentation. I want to print them out on index cards and post them around my monitor.
Outside of those questions, this book was all about the tooling. Not about content architecture, findability, not even about the usability and usefulness that he says tech writing is all about. For example, Etter says tech writers should use analytics to see if their docs are useful. And then he hops to saying that Google Analytics is THE TOOL to use. And that was it. No discussion on what sorts of metrics may be useful, how to maybe think about those metrics, etc. IT'S ALL ABOUT THE TOOLS, FOLKS. I'll definitely revisit this book when I need to evaluate tools.
December 2, 2020
Short and sweet. More of a guide rather than an introduction. With focus on the tools and what worked best for the author. And no, don't expect a silver bullet. You need to get your hands on to find out what best suits your needs.
July 24, 2022
I'm of two minds about this book. *Mind 1*: The model of technical writer that Andrew Etter describes is exactly the model that is being employed by software and cloud companies to do technical writing. His book is a useful document for this model. *Mind 2*: Andrew Etter is unaware (and surprisingly incurious) about the discipline of writing (in general) and tech writing (specifically). For example, he calls out writers who use the term 'gerund.' This is like calling out a mechanic who knows she is using a slip-joint plier when she knows she is using slip-joint plier. This means that while he presents the working model of the current state of the technical writer, and some useful tips on tools, he doesn't take the time to understand the context, his audience, and the massive gaps in this model of writer. Nor does he take the time to help technical writers that he de-rides for their interest in printed manuals, structured documentation, and the art of using language. His discussion on content reuse is one that is brief and pointless, although he does point out that 'single sourcing' is the Holy Grail of a technical writing team. It is impossible to create reusable content without strict adherence to a style guide. This requires both the practice and existence of a style guide, and also a means of getting writers to adhere to the style guide. In a highly distributed, decentralized, and largely ad hoc documentation environment, this is an enormous challenge. The entire book then and its brevity prove the point of the current state of tech writing.
In thinking about it, I can image aspiring writers reading this book and then coming away with some silly ideas about technical writing. Despite that, since this *is* the model I would recommend this book (with one star) to any practicing tech writer who wants to know both the useful elements of the current model of tech writing and to see the massive challenges that this model presents in creating coherent, current, and effective docs for technology that is in a continual state of change.
In thinking about it, I can image aspiring writers reading this book and then coming away with some silly ideas about technical writing. Despite that, since this *is* the model I would recommend this book (with one star) to any practicing tech writer who wants to know both the useful elements of the current model of tech writing and to see the massive challenges that this model presents in creating coherent, current, and effective docs for technology that is in a continual state of change.
October 13, 2018
It’s a good concise book that is specifically geared for technical writers in the software industry. He breaks down what technical writers need to do before they actually start writing such as how they are first testers and researchers and the actual writing comes later in the process of completing the project. Since it’s geared toward software documentation he goes into specifics about lightweight markup such as XML. And he describes why you should use static websites. So it’s a good book geared more toward technical writers already in the field but not the first book a complete newbie or someone without markup language knowledge should read first without some prior knowledge. But it’s definitely a technical writing book I recommend to writers in the field specifically those who want to do software documentation.
November 14, 2016
This book spent a lot of time on tooling, which surprised me but I suppose has been rather trendy lately. The discussion on tooling might be helpful if you are in the market for a new tooling system, or want to improve your own, or are a developer who happens to also be a tech writer. As a writer who is comfortable writing in a wiki and/or offline with a plain text editor, the discussion of using git or other DVC systems as simpler and better did not resonate.
To me, the guiding questions of the documentation I felt were the most valuable part of the book. Those resonated a bit better from the perspective of questions engineers ask of their product managers, and that push back at "why does this product even exist" and demanding that PM and Eng understand the end-to-end workflow of a customer experience with the product. I also enjoyed his points about how to use analytics as validation or rejection of your assumptions or even to better understand your success criteria.
Overall, there were many useful nuggets in here, but for such a short book I might even only read half or less of it unless I needed to learn about tooling options available to me. The author's tone throughout did make me giggle though.
To me, the guiding questions of the documentation I felt were the most valuable part of the book. Those resonated a bit better from the perspective of questions engineers ask of their product managers, and that push back at "why does this product even exist" and demanding that PM and Eng understand the end-to-end workflow of a customer experience with the product. I also enjoyed his points about how to use analytics as validation or rejection of your assumptions or even to better understand your success criteria.
Overall, there were many useful nuggets in here, but for such a short book I might even only read half or less of it unless I needed to learn about tooling options available to me. The author's tone throughout did make me giggle though.
January 27, 2021
The book is a good introduction to modern technical writing in the software industry. It briefly touches on some important topics relevant for the technical writing field (e.g., audience, style, or localization) and focuses mainly on creating online documentation - that is, documentation that is accessible online (as a website) and can be updated on a regular basis. To create and maintain such documentation, you can use special tools (Markdown, AsciiiDoc, Git, Sphinx etc.) and techniques (publish frequently, don't duplicate, don't localize etc.).
However, the book is rather short and provides only basic information about creating and publishing software documentation. For example, you do not find here any details about generating a documentation site or setting up a continuous delivery pipeline.
However, the book is rather short and provides only basic information about creating and publishing software documentation. For example, you do not find here any details about generating a documentation site or setting up a continuous delivery pipeline.
July 24, 2025
This is a short book but straight to the point. The author explains how the technical writing process works from beginning to end. It starts with research and learning, moves to defining your audience, and then focuses on answering important questions—no fluff, just what users need to know.
Some sections cover the tools the author uses during writing: version control systems, writing formats (Markdown, reStructuredText, AsciiDoc), small scripts, localization tips, and even how to run a static website to host the docs. However, the book doesn't go deep into any of these. If you want to try them out, you'll need to look elsewhere for more details.
One thing I wish it had is an updated version with something on how the writing process has changed with recent AI tools.
Still, I think this book could be helpful if you want to start writing about tools or products you build.
Some sections cover the tools the author uses during writing: version control systems, writing formats (Markdown, reStructuredText, AsciiDoc), small scripts, localization tips, and even how to run a static website to host the docs. However, the book doesn't go deep into any of these. If you want to try them out, you'll need to look elsewhere for more details.
One thing I wish it had is an updated version with something on how the writing process has changed with recent AI tools.
Still, I think this book could be helpful if you want to start writing about tools or products you build.
October 1, 2023
A great introduction to the world of Technical Software Documentation, like the tittle says, it's an introduction (a really good one) so don't expect too much technical language.
Now from my perspective as an IT student, this book is invaluable, the knowledge shared is so fluid, concise and with easy examples from daily life, making the lecture fast and light.
I suggest you to read this book always making notes and highlighting unknown terms, softwares and tips for later use or search. Also use the online kindle website to search the terms and programs mentioned here if you're using the kindle to read and talking about that: The codes used on this book shows without a problem on kindle, so dont worry about using it and happy reading!
Now from my perspective as an IT student, this book is invaluable, the knowledge shared is so fluid, concise and with easy examples from daily life, making the lecture fast and light.
I suggest you to read this book always making notes and highlighting unknown terms, softwares and tips for later use or search. Also use the online kindle website to search the terms and programs mentioned here if you're using the kindle to read and talking about that: The codes used on this book shows without a problem on kindle, so dont worry about using it and happy reading!
July 27, 2018
Modern Technical Writing is great. It's short: you can read it in an hour. It gets right to the point, and shows you what you need, and why.
Understand your audience. Create content they will find useful. Give them the minimum information they need, *and no more*. This book is a good advocate for writing *less*, so you're not wasting your time on work that is ignored or thrown away.
Etter also encourages writing useful software changelists, so he now holds a special place in my heart.
In short: all tech writers should read this. All programmers should read it too!!
Understand your audience. Create content they will find useful. Give them the minimum information they need, *and no more*. This book is a good advocate for writing *less*, so you're not wasting your time on work that is ignored or thrown away.
Etter also encourages writing useful software changelists, so he now holds a special place in my heart.
In short: all tech writers should read this. All programmers should read it too!!
February 10, 2021
Short, sweet, to the point.
It covers the tone we need to use, it covers the tools he recommends, and it covers a "plausible scenario" of work, of pipeline to create documentation. What else can I say?
I did not know how static site generators worked, or that I could build documentation, but it all makes sense.
So, his tips are most welcome, specially because in my workplace it was decided to bring down the wiki because potential threads.
But, with static documentation, what can you say? Fast, secure... and a good option to present to management.
It covers the tone we need to use, it covers the tools he recommends, and it covers a "plausible scenario" of work, of pipeline to create documentation. What else can I say?
I did not know how static site generators worked, or that I could build documentation, but it all makes sense.
So, his tips are most welcome, specially because in my workplace it was decided to bring down the wiki because potential threads.
But, with static documentation, what can you say? Fast, secure... and a good option to present to management.
June 4, 2021
This is a no-nonsense writing book that skips all the fluffy parts from books you've probably already read, where they talk about the mindset and attitude of a technical writer. Those are important too, but this book gets down to business with the tools you need and platforms that can help you not just write something, but write something that is valuable and sustainable. Highly recommended for anyone writing in tech (and that includes software engineers).
November 16, 2018
Modern Technical Writing
An easy to read book, and at the same time provides extensive information on many subjects that might keep any technical writer awake at night. If you are want to learn or consider shifting to structured documentation, this book is a great place to start.
An easy to read book, and at the same time provides extensive information on many subjects that might keep any technical writer awake at night. If you are want to learn or consider shifting to structured documentation, this book is a great place to start.
December 13, 2022
Weirdly short. And suspiciously succint. Seems more like a few blog posts put together than a book.
I do not disagree with most of what the author says. But dismissing style guides, completely!, and saying of AsciiDoc that you do not enough to write about it make me highly skeptical about the rest of the content.
I do not disagree with most of what the author says. But dismissing style guides, completely!, and saying of AsciiDoc that you do not enough to write about it make me highly skeptical about the rest of the content.
October 31, 2023
As author promised: short, clear and beautifully written. I made more notes from this relatively short book than from any other ones. It’s that useful! (For me at least). Totally recommend for every technical writer, no matter if you are experienced one or just a beginner (as myself). I am sure everyone will find something useful for themselves.
April 23, 2025
I am doing some technical writing for a small company. After reading this book I cannot say I am technical writer -- yet.
It is a short book, but filled with useful insights: what to write, understanding your audience, developing a style, and what tools to use (NOT MS word or google docs which are only suitable for memos and other basic business writing!).
It is a short book, but filled with useful insights: what to write, understanding your audience, developing a style, and what tools to use (NOT MS word or google docs which are only suitable for memos and other basic business writing!).
July 21, 2018
Generally, this book is a good reference for beginners in technical writing. Many face the difficulty to start, choosing the right tools and best practices. Andrew clarifies that in his book, he compares between writing tools based on his knowledge and experience.
August 18, 2019
Interesting and right to the point
The fact that this book is short is actually a plus to me. It was well written, never boring and informative on what the technical writer job is. Recommend!
The fact that this book is short is actually a plus to me. It was well written, never boring and informative on what the technical writer job is. Recommend!
November 10, 2019
Refreshingly Candid Take on Tech Writing
Just enough material for a thorough overview of tech writing. I thought it would catch me up on the major aspects of the field, and I was 100% right.
Just enough material for a thorough overview of tech writing. I thought it would catch me up on the major aspects of the field, and I was 100% right.
July 20, 2020
Good, practical tips for keeping technical writing lean and honest. Focused more on the writing pipeline, tools, and hosting of documentation rather than on style and content itself. Learned a few useful tricks along the way.
August 17, 2020
Very straightforward and straight to the point. It is good to learn or refresh the main points of technical writings. It also provides some free-to-use tools that may save you time researching it yourself. Highly recommendable.
March 14, 2021
Simple and understandable book about technical writing
Simple and understandable book about technical writing. Relevant for developers who want to transition to technical writing. Absolutely reccomend it
Simple and understandable book about technical writing. Relevant for developers who want to transition to technical writing. Absolutely reccomend it
January 30, 2022
In this book Andrew Etter clearly and concisely describes how documentation is an important aspect of software development nowadays. I was searching for a book like this one, and it already helped me a lot with several doubts.
October 31, 2022
It's a short and easy-to-read book.
Andrew Etter conveys his experience very well.
This book presents 2 parts:
1. Fundamentals, which every technical writer should know.
2. Lots of language and tools, which are very useful. There are quite clear comparisons of the pros and cons.
I like this book. I can use the knowledge from this book to be useful in my work a lot.
Andrew Etter conveys his experience very well.
This book presents 2 parts:
1. Fundamentals, which every technical writer should know.
2. Lots of language and tools, which are very useful. There are quite clear comparisons of the pros and cons.
I like this book. I can use the knowledge from this book to be useful in my work a lot.
July 29, 2023
Not useful for an absolute beginner.
The book is not meant for people getting into technical writing as a fresher. It's for writers who already have a know how of the tools used in TW or are already well established technical writers.
The book is not meant for people getting into technical writing as a fresher. It's for writers who already have a know how of the tools used in TW or are already well established technical writers.
June 15, 2017
Quick and effective overview of what technical writing is and is not. It also offers some great recommendations for markdown editors and DVCS apps, as well as other helpful tools.
November 15, 2017
Short and sweet read for those starting out and looking to write "document as code".
August 24, 2018
An excellent small and very opinionated book that should be mandatory reading at any Computer Science course and also by anyone coming from outside of CS into technical writing.
January 2, 2019
Great overview of Technical Writing
I highly recommend Modern Technical Writing. I have been a Web and Technical Writer/Editor for most of my career, but during the last five years, I have been more focused on Web communication. I found this book on Amazon and thought that it would be a great refresher, and I was right. It’s also a great primer for people who are new to Technical Writing.
I highly recommend Modern Technical Writing. I have been a Web and Technical Writer/Editor for most of my career, but during the last five years, I have been more focused on Web communication. I found this book on Amazon and thought that it would be a great refresher, and I was right. It’s also a great primer for people who are new to Technical Writing.
August 8, 2019
A good read.
Only reason I’m not giving 5 stars is that I keep it for something exceptional. I do recommend this book.
Only reason I’m not giving 5 stars is that I keep it for something exceptional. I do recommend this book.
December 26, 2019
I LIKE THIS BOOK.
Displaying 1 - 30 of 38 reviews