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
Administrators install and configure applications. I'm not just talking about server administrators or people with administrator permissions on a computer, but anyone whose concerns are setup and maintenance.
Andrew Etter • Modern Technical Writing
you should break your writing into bite-sized pieces, often called topics, none of which overlap in content.
Andrew Etter • Modern Technical Writing
A good rule of thumb is to treat everyone as busy individuals whose time is valuable, but another rule of thumb is to break this rule and be more of a jerk if an essential employee isn't giving you the information you need to do your job.
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
if things change—and things always change—you only have to update the documentation in one place.
Andrew Etter • Modern Technical Writing
How do I install the product? What are the basic configuration options, if any?
Andrew Etter • Modern Technical Writing
Plenty of lightweight markup languages exist, but only three are really worth discussing: Markdown, reStructuredText, and AsciiDoc.
Andrew Etter • Modern Technical Writing
Learn everything about a subject. Write down exactly what an audience needs to know and no more. Make the content beautiful, discoverable, scannable, and searchable. Consider everything a draft, and iterate relentlessly. Make contribution simple.