The Not-Boring Tech Writer

Skill #3: Creating Just-in-Time Documentation


Listen Later

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:

  • Zendesk
  • Zapier
  • KnowledgeOwl
  • Google Custom Search
  • Bri’s Twitter
  • Bri’s super awesome documentation
...more
View all episodesView all episodes
Download on the App Store

The Not-Boring Tech WriterBy Kate Mueller

  • 4.9
  • 4.9
  • 4.9
  • 4.9
  • 4.9

4.9

15 ratings


More shows like The Not-Boring Tech Writer

View all
I'd Rather Be Writing Podcast by Tom Johnson

I'd Rather Be Writing Podcast

11 Listeners

The Daily by The New York Times

The Daily

112,858 Listeners

Scamfluencers by Wondery

Scamfluencers

7,398 Listeners

Wild Card with Rachel Martin by NPR

Wild Card with Rachel Martin

996 Listeners