Skill #3: Creating Just-in-Time Documentation
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:
The Show Notes:
Creators and Guests
Host
Jacob Moses
Jacob Moses is the founder and original host of The Not-Boring Tech Writer podcast, which he launched in 2016 to celebrate tech writers and push back against the stereotype that technical writing is boring. He studied technical communication at the University of North Texas, and his first gig out of college was as a tech writer at Rainmaker Digital (formerly Copyblogger Media). Since then, he's carried the skills and values he cultivated as a tech writer into community development and real estate. Today, Jacob is owner of Care Block Development, a real estate development company that acquires, rehabs, and manages historic buildings in Denton, Texas. Pairing historic preservation with thoughtful improvements, Care Block honors the culture of the neighborhoods in which it works to create lovable places for the people it serves. He's also the owner of Sardinha, a premium tinned seafood pop-up pushing premium tins in Denton. If you need a tinfish plug in Denton, Jacob is your guy.
