Category Archives: Technical Communication

Posts related to technical communication

Structured Writing is Essential for Developer Docs

Tom Johnson wrote a post recently in which he questioned the value of structured writing for developer documentation. Needless to say, I disagree. But Tom and I are not really at odds here. Rather, he means something different by “structured writing” than I do. Structured writing is about content quality, not publishing What I mean… Read More »

The Goal of Tech Comm is to Enable Correct Action

The purpose of technical communication is not to translate complex information into simple terms, but to enable the reader to act correctly. Tom Johnson has a great blog post laying out An argument for complexity rather than simplicity in technical communication. Many products, Tom argues, are complex, and to pretend otherwise is to do the reader… Read More »

Don’t Lean on Development’s Agile Process

Don’t just try to fit into development’s agile process. Create your own lean content development process. Technical writers are increasingly finding themselves involved in the agile process of the development organization.  The most common way this happens is that a writer gets assigned to the team for a sprint and is expected to produce documentation… Read More »

We Can’t Use “In Tray” Definitions for Content Roles

Everyone in the content industry seems to be trying to define their roles these days. There are a number of new roles and titles being described, and everyone wants to know where to draw the boundaries around them. Commenting on my recent post on Content Engineering, Jonatan Lundin asked, “So is an information architect a… Read More »

Content Engineering is Not Technical Writing

My last post, I am a Content Engineer, was taken by several people as yet another attempt to rebrand technical writing. I’m honestly a bit mystified by how people could interpret some of the examples of content engineering that I listed as being examples of technical writing, but Hi Ho. Let me set the record… Read More »