This via r/programming today: On Writing Documentation.
Category Archives: Writing
Flash Fiction Stories: 25 Examples of Lighting-Fast Stories
Today I discovered: Flash Fiction Stories: 25 Examples of Lighting-Fast Stories. There’s some cool stories in there. I didn’t read all of them.
Technical Writing Courses
Today I discovered: Technical Writing Courses via Docs for Developers.
Documenting APIs: A guide for technical writers and engineers
Today I discovered: Documenting APIs: A guide for technical writers and engineers.
LaTeX \input vs \include
Today I discovered When should I use \input vs. \include? in which I learned about the LaTeX \input command.
How To Win At Tech Publishing
From How To Win At Tech Publishing:
If, however, you’ve accumulated a lot of research on a personal topic and want to gather the threads together and reach some personal conclusions, long-form non-fiction is probably the only tool that’s going to work, whether you publish or not.
The documentation system
Today I discovered The documentation system (over here). The four quadrants on two axes are:
- Tutorials
- How-to guides
- Reference
- Explanation
Build tools around workflows, not workflows around tools
Today I enjoyed reading Build tools around workflows, not workflows around tools. Taken with John Romero’s advice to build your own tools I feel I am on the right path with some of my current projects.
A Vim Guide for Advanced Users
Today I stumbled upon A Vim Guide for Advanced Users. Learned a trick or two, but it’s still a long road ahead for me.
The Chicago Manual of Style
Today I read the Preface from The Chicago Manual of Style, 17th Ed. The whole thing doesn’t appear to be available for free online; I will consider purchasing a copy.