Programming By Stealth

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

Programming By StealthBy Bart Busschots & Allison Sheridan

  • 5
  • 5
  • 5
  • 5
  • 5

5

15 ratings


More shows like Programming By Stealth

View all
How Did This Get Made? by Earwolf and Paul Scheer, June Diane Raphael, Jason Mantzoukas

How Did This Get Made?

23,113 Listeners

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

Mac Geek Gab — Apple Tips, Tricks, and Troubleshooting

836 Listeners

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

NosillaCast Apple Podcast

164 Listeners

Mac Power Users by Relay

Mac Power Users

1,288 Listeners

Chit Chat Across the Pond by Allison Sheridan

Chit Chat Across the Pond

9 Listeners

The Vergecast by The Verge

The Vergecast

3,702 Listeners

Taming the Terminal by Bart Busschots & Allison Sheridan

Taming the Terminal

21 Listeners

Interesting Times with Ross Douthat by New York Times Opinion

Interesting Times with Ross Douthat

7,226 Listeners

Conversations With Coleman by The Free Press

Conversations With Coleman

568 Listeners

Huberman Lab by Scicomm Media

Huberman Lab

29,132 Listeners

Honestly with Bari Weiss by The Free Press

Honestly with Bari Weiss

8,730 Listeners