
Saved by Minny and
Modern Technical Writing
Saved by Minny and
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.
Plenty of lightweight markup languages exist, but only three are really worth discussing: Markdown, reStructuredText, and AsciiDoc.
Users are people who just want to achieve something with an application, whether it's resizing an image, creating a spreadsheet, or searching a database.
How do I install the product? What are the basic configuration options, if any?
What is this product? Why would anyone want it?
you should break your writing into bite-sized pieces, often called topics, none of which overlap in content.
Where can I acquire this product? If there are multiple distribution packages, which should I choose and why?
we can roughly divide readers into three groups: users, administrators, and developers.
Technical writers, first and foremost, are testers and researchers. Your job is to know what people want to achieve and precisely how to achieve it.