Tips for writing great documentation

I recently read a great article by Taylor Singletary who’s been writing documentation for customer facing products that almost all of us use: LinkedIn, Twitter, and Slack. If you ask him, he says he works in “developer relations.” He wrote up the list of things he does to create great, usable, customer-facing documentation: Continue reading “Tips for writing great documentation”

Collaboration – Love it or Hate it?

by Liz Fraley, CEO of Single-Sourcing Solutions

This month I wanted to find out if you have come to love or hate collaboration in any of it’s forms.  I’m a big experimenter which often means I’m a big collaborator.

In January’s TC Dojo, we had Karl Klashinsky do a session on Git, the open source software version control system. He mentioned something in passing that software developers take for granted but that technical writers resist: the idea of continuous commits. In other words, commit early and often.

For Techcomm folks, providing access to in-work content has been traditionally a difficult activity. Writers tend to wait until something is done before anyone sees it. We like to pretend to the outside world that our work “sprung complete from [our] mind into the repository in utter perfection with each concept fully thought out” (Seth Robertson).

Continue reading “Collaboration – Love it or Hate it?”

Paper or ePub?

Did you know that reading on a kindle or other electronic device isn’t the same to your brain as reading on paper?

Well, as it turns out:

Neuroscience, in fact, has revealed that humans use different parts of the brain when reading from a piece of paper or from a screen. So the more you read on screens, the more your mind shifts towards “non-linear” reading — a practice that involves things like skimming a screen or having your eyes dart around a web page. –pri.org

Continue reading “Paper or ePub?”