Modern Technical Writing
Where can I acquire this product? If there are multiple distribution packages, which should I choose and why?
Andrew Etter • Modern Technical Writing
What is this product? Why would anyone want it?
Andrew Etter • Modern Technical Writing
Tailor your approach to the person, come prepared to meetings, batch your questions into related sets rather than bothering people every twenty minutes with individual questions, and thank everyone for their time.
Andrew Etter • Modern Technical Writing
The worst duplication sin of all is to store similar copies of the same documentation in version control. The root cause here is typically the desire to have one version for coworkers and another for customers, and it inevitably leads to a maintenance nightmare.
Andrew Etter • Modern Technical Writing
Developers extend applications or interfaces with code. They want to improve some aspect of an existing application or build something new.
Andrew Etter • Modern Technical Writing
What does a simple, start to finish operation look like?
Andrew Etter • Modern Technical Writing
When people say, "I was writing all day," they don't mean they were intermittently typing for eight straight hours. They mean they spent the entire day engaged in the writing process. And a big part of that process is installing, configuring, and testing software—in other words, learning.
Andrew Etter • Modern Technical Writing
some amount of duplication is always going to occur. But for the most part, linking liberally, arranging topics in a sensible way, and trying to adhere to a single source model is a good idea.
Andrew Etter • Modern Technical Writing
we can roughly divide readers into three groups: users, administrators, and developers.