
The Return of Dave Lonning, Documentation Wrangler
It's probably no surprise that writing software is a somewhat difficult ...
June 6, 202229m 16s
Audio is streamed directly from the publisher (d2vstsfo8knv0p.cloudfront.net) as published in their RSS feed. Play Podcasts does not host this file. Rights-holders can request removal through the copyright & takedown page.
Show Notes
Full transcript and show notes at <a href='https://theomnishow.omnigroup.com/episode/the-return-of-dave-lonning-documentation-wrangler/'>theomnishow.omnigroup.com</a>
<p>It's probably no surprise that writing software is a somewhat difficult task. There's an unfathomable amount of iteration and detective work that goes into creating a product that feels intuitive for the new user, yet familiar to the ardent fan.</p>
<p>Surprisingly, the art of crafting effective software documentation demands some of the exact same iteration and detective skills. Inserting helpful guidance at just the right point in the user conversation (without over-explaining) can be a tricky dance.</p>
<p>Luckily, Dave Lonning, documentation wrangler, is up to the challenge. He returns to the Omni show (<a href="https://theomnishow.omnigroup.com/episode/dave-lonning-documentation-wrangler">Episode 10</a>, for you longtime listeners!) to talk about how his role has shifted over the last few years. Andrew and Dave discuss how he's approached the fresh challenges emerging in the software documentation process.</p>
<p>You can find Dave <a href="https://twitter.com/davelonning">@davelonning</a> on Twitter.</p>
<p>Some other people, places, and things mentioned:</p>
<ul>
<li><a href="https://developer.apple.com/library/content/documentation/Carbon/Conceptual/ProvidingUserAssitAppleHelp/authoring_help/authoring_help_book.html">Apple Help format</a></li>
<li><a href="https://en.wikipedia.org/wiki/Apple_Help_Viewer">Apple Help Viewer</a></li>
<li><a href="https://developer.apple.com/documentation/webkit/webview">WebView</a></li>
<li><a href="https://en.wikipedia.org/wiki/EPUB">EPUB</a></li>
<li><a href="https://www.apple.com/ibooks/">iBooks</a></li>
<li><a href="https://en.wikipedia.org/wiki/Portable_Document_Format">PDF</a></li>
<li><a href="https://www.omnigroup.com/omnigraffle">OmniGraffle</a></li>
<li><a href="https://www.omnigroup.com/omnifocus">OmniFocus</a></li>
<li><a href="https://www.omnigroup.com/omnioutliner/">OmniOutliner</a></li>
<li><a href="https://www.omnigroup.com/omniplan/">OmniPlan</a></li>
<li><a href="https://www.omnigroup.com/slack/">Omni Slack Channel</a></li>
<li><a href="https://www.Omni-Automation.com">Omni-Automation.com</a></li>
<li><a href="https://support.omnigroup.com/manuals/">Documentation at support.omnigroup.com</a></li>
</ul>