In a former life, I was a technical writer. Scratch that, I was a damn good technical writer, the lack of appreciation from one Southeast Michigan-based employer not withstanding. I dreaded every minute spent writing a manual, help system, or technical spec. But I was damn good at doing it.
That said, it's not hard to be a technical writer. It is hard to be a good technical writer, however. So, to all you struggling tech writers, take this small piece of advice from a tech writer turned pseudo-developer/business process analyst: every blurb of documentation you put out should lead to a measurable outcome. Yes, you have to do the expository "this is why we built it this way" crap, but if I can't act on the information you put out, that information is worthless - documentative lint, if you will.
This post brought to you by two weeks of frustration caused by bad documentation. Frustration, I might add, that was cleared up by a 5 minutes phone call with a very accessible Subject Matter Expert.
Twitter has pushed me too far
Inspired by Matt Haughey's stand against Twitter , I re-logged into Mastodon on all my devices and shelved my Twitter access. I haven&#...
-
Tom Petty died today , aged 66. I won't claim to be a huge Tom Petty fan, but I've bought an album or two and sang along in the car ...
-
My work domain (an EDU) recently had Google Inbox enabled so I had a good chance to try it out. My personal email is relatively quiet and, I...
-
Evernote, for better or worse, is the best note-taking service for my needs. It works across all my devices/computers/modes. It's fairly...
No comments:
Post a Comment