Skip to content
Artwork for Ask Noah Show
Ask Noah Show · September 16 · 53 min

Ask Noah Show 506

This week Steve gives the deep dive into the reason and the how for documentation. It's an essential thing in any IT environment, it doesn't get nearly enough love so we shine a spotlight on it. -- During The Show -- 00:45 Intro Sound effects RPG Web UI Never Winter Nights Kansas City Steve and traveling 09:18 News Wire GTK 4.24 - gnome.org Shotwell 33 - gnome.org Agama Installer 24 - github.io Cosmic v1.8 https://www.phoronix.com/news/COSMIC-Epoch-1.8 Debian 13.7 Trixie - debian.org MocaccinoOS 26.09 - mocaccino.org DietPi 10.7 - dietpi.com KaOS 2026.09 - kaosx.us Ubuntu 24.04.5 - phoronix.com Sandbox Challenge - securityweek.com Lunar Exploration Model - ibm.com CUDA-Q Expands - nvidia.com 10:30 Documentation Document "why" something was done Assumption and argument What needs to be documented Reproducer - Blow it away and set it up again Document everything Why do people resist documenting Executive vs Technical Summaries Tribal knowledge Styles of documentation White papers CMA What should you NOT document Process of documenting Where do you document Wiki.js Markdown Steve's container documentation Steve's GitHub Steve's Red Hat profile Hackaday -- The Extra Credit Section -- For links to the articles and material referenced in this week's episode check out this week's page from our podcast dashboard! This Episode's Podcast Dashboard Phone Systems for Ask Noah provided by Voxtelesys Join us in our dedicated chatroom #GeekLab:linuxdelta.com on Matrix -- Stay In Touch -- Find all the resources for this show on the Ask Noah Dashboard Ask Noah Dashboard Need more help than a radio show can offer? Altispeed provides commercial IT services and they’re excited to offer you a great deal for listening to the Ask Noah Show. Call today and ask about the discount for listeners of the Ask Noah Show! Altispeed Technologies Contact Noah live [at] asknoahshow.com -- Twitter -- Noah - Kernellinux Ask Noah Show Altispeed Technologies Support Ask Noah Show

0:00-53:53

transcript

No transcript — this publisher did not publish one.

show notes

This week Steve gives the deep dive into the reason and the how for documentation. It's an essential thing in any IT environment, it doesn't get nearly enough love so we shine a spotlight on it.

-- During The Show --

00:45 Intro

  • Sound effects
  • RPG Web UI
  • Never Winter Nights
  • Kansas City
  • Steve and traveling

09:18 News Wire

10:30 Documentation

  • Document "why" something was done
  • Assumption and argument
  • What needs to be documented
  • Reproducer - Blow it away and set it up again
  • Document everything
  • Why do people resist documenting
  • Executive vs Technical Summaries
  • Tribal knowledge
  • Styles of documentation
  • White papers
  • CMA
  • What should you NOT document
  • Process of documenting
  • Where do you document
  • Wiki.js
  • Markdown
  • Steve's container documentation
  • Steve's GitHub
  • Steve's Red Hat profile
  • Hackaday

-- The Extra Credit Section --

For links to the articles and material referenced in this week's episode check out this week's page from our podcast dashboard!

This Episode's Podcast Dashboard

Phone Systems for Ask Noah provided by Voxtelesys

Join us in our dedicated chatroom #GeekLab:linuxdelta.com on Matrix

-- Stay In Touch --

Find all the resources for this show on the Ask Noah Dashboard

Ask Noah Dashboard

Need more help than a radio show can offer? Altispeed provides commercial IT services and they’re excited to offer you a great deal for listening to the Ask Noah Show. Call today and ask about the discount for listeners of the Ask Noah Show!

Altispeed Technologies

Contact Noah

live [at] asknoahshow.com

-- Twitter --

Support Ask Noah Show

links24

more episodes

All episodes