I’ve been thinking about documentation tools and publishing platforms. I’m evaluating what I have, and what more I need. To be less vague: I have an online knowledge base/help center. What I need, or might need, is a way to provide that content to users who aren’t online.
After setting up and writing content for wikis and other online-only systems for years, the concept of “offline documentation” seems obsolete, even primitive. But I have to admit that there are still some use cases for it, even if the letters P, D, and F make me shudder in fear.
Ok, that might be overstating it a little.
Continue reading “Online vs. offline documentation”
In my previous post, I described how I structure release notes, and what sort of content I include in them. This time, I’m going to focus on gathering information, when to release the release notes, and how to let your users know that they exist.
I’ve been writing release notes this week. This is a new thing for my company, so I get to decide what they include and what they look like. I’ve written release notes many times before, for different companies with different requirements and styles. I’ve filtered all of those styles into what I think of as a “general” style for release notes, which is my go-to style: short, uncluttered, let the reader get the info as quickly as possible.
But let’s see how that idea holds up once I start analyzing it.
My role is changing again, but this time back towards tech writing and support. I’m moving away from customer success, and away from direct training; but to be honest, I hadn’t been doing much of either, so it really comes down to continuing to do what I’ve been doing. Although that will probably change, and expand, in the future.
Confusing? Yeah, to me, too, but it’s not at all bad. And I think it reflects something becoming more common for us content creators.
Continue reading “Docs and sales and changing roles”