Pilot reading checklist.

Docs that are Part of Larger Systems

It is easy to think of documentation as simply the reader’s companion, which they use when they need help with a product or service. But a lot of documentation is more than this, it is part of an industrial or institutional system. Designing and writing documentation to be part of such a system can be […]

Continue Reading

Design for Wayfinding

Much of the time we spend with technical documentation is concerned with wayfinding. That is, it is not about performing the actual operation, but about finding which operation to perform, and finding the piece of content that describes the operation in a form that we can understand. Note that there are two distinct components to […]

Continue Reading
Portrait with bookcase.

Content as Furniture

Summary: Content is no longer furniture; it is a utility. We have to learn to treat it as such. I am in the last throes of our move from Ottawa to Kitchener-Waterloo, Ontario, which involves moving a lot of content. Boxes and boxes of great heavy lumps of paper and ink content. Great gaping room-swallowing […]

Continue Reading

Short: good policy, bad metric

We seem to agonize endlessly over how long content should be. Metrics are regularly proposed for the perfect length of a blog post or content marketing piece, and the move towards topic-based writing has tech writers worrying about similar issues. Keeping content short is certainly good policy. No one wants to read more than they have […]

Continue Reading