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
Making proper use of links lets us attain a sort of Holy Grail in technical writing: single sourcing.
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
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.
Andrew Etter • Modern Technical Writing
What does a simple, start to finish operation look like?
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
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
What topics should be is relatively complete in their discussion of a particular subject.
Andrew Etter • Modern Technical Writing
How does this product fit into a broader ecosystem, if at all? Does it have any dependencies?