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.

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.

What does a simple, start to finish operation look like?

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.

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.

Plenty of lightweight markup languages exist, but only three are really worth discussing: Markdown, reStructuredText, and AsciiDoc.

How does this product fit into a broader ecosystem, if at all? Does it have any dependencies?

Developers extend applications or interfaces with code. They want to improve some aspect of an existing application or build something new.

How do I install the product? What are the basic configuration options, if any?