Chit Chat Across the Pond

CCATP #706 – Bart Busschots on PBS 130 of X – Good Technical Documentation


Listen Later

As we embark on our journey to create a JavaScript module for the strong, memorable password generating service XKPASSWD, Bart explains the importance of creating good documentation. That sounds super annoying and tedious, and it is, so Bart explains why a good documentation generator will be our friend. He outlines the two distinctly different users of our documentation: those of us who will be helping to create the code itself as part of the community project, but also for the people who will be users of our JavaScript module. Those users will be interested in how to take the module and embed it into a web page to generate passwords, or to create an Alfred scheme and more. These two different users will have different requirements, and yet our documentation generator can fill both needs without unnecessary extra work. This isn't the sexiest topic, but Bart does convince me that the tools will help us to have the rigor to do it and not let our human instincts take over and allow our documentation to get out of date.

You can find Bart's fabulous shownotes at pbs.bartificer.net

...more
View all episodesView all episodes
Download on the App Store

Chit Chat Across the PondBy Allison Sheridan

  • 4.8
  • 4.8
  • 4.8
  • 4.8
  • 4.8

4.8

9 ratings


More shows like Chit Chat Across the Pond

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

826 Listeners

NosillaCast Apple Podcast by Technology with an EVER so slight Apple bias

NosillaCast Apple Podcast

158 Listeners

MacVoices by Chuck Joiner

MacVoices

33 Listeners

Mac OS Ken by Ken Ray

Mac OS Ken

891 Listeners

MacBreak Weekly (Audio) by TWiT

MacBreak Weekly (Audio)

2,014 Listeners

Mac Power Users by Relay

Mac Power Users

1,280 Listeners

The CultCast by America's favorite Apple Podcast

The CultCast

1,163 Listeners

Macworld Podcast by Foundry

Macworld Podcast

305 Listeners

Clockwise by Relay

Clockwise

249 Listeners

Upgrade by Relay

Upgrade

1,192 Listeners

AppleInsider Podcast by AppleInsider

AppleInsider Podcast

957 Listeners

Taming the Terminal by Bart Busschots & Allison Sheridan

Taming the Terminal

20 Listeners

The Checklist by SecureMac by SecureMac

The Checklist by SecureMac

67 Listeners

Programming By Stealth by Bart Busschots & Allison Sheridan

Programming By Stealth

14 Listeners

9to5Mac Daily by 9to5Mac

9to5Mac Daily

499 Listeners

Techmeme Ride Home by Brian McCullough

Techmeme Ride Home

942 Listeners