Skill #3: Creating Just-in-Time Documentation

The Not-Boring Tech Writer - A podcast by Kate Mueller

Categories:

Face it: sometimes, documenting software can be tricky.Not because we don’t understand the software – we get that. Nor because we can’t articulate it in layman’s terms – we’ve got that covered, too.But because feature guides – the traditional style of software documentation – isn’t enough to ensure your end users can find the information they need to accomplish a specific task.Enter just-in-time documentation: a new methodology of documentation that complements feature guides by creating task-oriented documents, as our guest Bri Hillmer describes it, “just in time, when the customer asks the question.”In this episode, you’ll learn about the power of just-in-time documentation and how you can apply it to your documentation today.The Show Notes:ZendeskZapierKnowledgeOwlGoogle Custom SearchBri’s TwitterBri’s super awesome documentation