The Omni Show

The Return of Dave Lonning, Documentation Wrangler


Listen Later

Full transcript and show notes at theomnishow.omnigroup.com

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.

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.

Luckily, Dave Lonning, documentation wrangler, is up to the challenge. He returns to the Omni show (Episode 10, 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.

You can find Dave @davelonning on Twitter.

Some other people, places, and things mentioned:

  • Apple Help format
  • Apple Help Viewer
  • WebView
  • EPUB
  • iBooks
  • PDF
  • OmniGraffle
  • OmniFocus
  • OmniOutliner
  • OmniPlan
  • Omni Slack Channel
  • Omni-Automation.com
  • Documentation at support.omnigroup.com
  • ...more
    View all episodesView all episodes
    Download on the App Store

    The Omni ShowBy The Omni Group

    • 4.5
    • 4.5
    • 4.5
    • 4.5
    • 4.5

    4.5

    45 ratings


    More shows like The Omni Show

    View all
    Mac Geek Gab — Apple Tips, Tricks, and Troubleshooting by Dave Hamilton, Pilot Pete & Adam Christianson

    Mac Geek Gab — Apple Tips, Tricks, and Troubleshooting

    827 Listeners

    Mac OS Ken by Ken Ray

    Mac OS Ken

    890 Listeners

    The Vergecast by The Verge

    The Vergecast

    3,661 Listeners

    Mac Power Users by Relay

    Mac Power Users

    1,280 Listeners

    The Talk Show With John Gruber by Daring Fireball / John Gruber

    The Talk Show With John Gruber

    3,115 Listeners

    Accidental Tech Podcast by Marco Arment, Casey Liss, John Siracusa

    Accidental Tech Podcast

    2,092 Listeners

    Connected by Relay FM

    Connected

    568 Listeners

    Upgrade by Relay

    Upgrade

    1,199 Listeners

    The Productivity Show by Asian Efficiency

    The Productivity Show

    510 Listeners

    Getting Things Done by GTD®

    Getting Things Done

    453 Listeners

    Cortex by Relay

    Cortex

    1,260 Listeners

    Focused by Relay

    Focused

    120 Listeners

    AppStories by Federico Viticci, John Voorhees

    AppStories

    508 Listeners

    Automators by Relay

    Automators

    167 Listeners

    Deep Questions with Cal Newport by Cal Newport

    Deep Questions with Cal Newport

    1,276 Listeners