
Modern Technical Writing

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.
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
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 topics should be is relatively complete in their discussion of a particular subject.
Andrew Etter • Modern Technical Writing
Good change logs convince people to upgrade, inspire confidence in the direction of a product, and help developers take advantage of new features.
Andrew Etter • Modern Technical Writing
we can roughly divide readers into three groups: users, administrators, and developers.
Andrew Etter • 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
the better approach is to use a feature sometimes called "conditional text." Conditional text lets you selectively include or exclude files (or portions of files) in the final output.
Andrew Etter • Modern Technical Writing
How do I install the product? What are the basic configuration options, if any?