Skip to main content

Lessons on documenting the lab

  • Document for the reader you were. The most valuable pages explain the why and the mistakes, because that's what you couldn't find when you started.
  • Let the tool's structure guide you. Shelf → book → page keeps things findable; fight it and you get sprawl.
  • One idea per page. Short pages get read; long ones get skimmed.
  • Automate the docs too. The API turns "I'll document it later" into "the script published it." Docs that can be regenerated are docs that stay true.
  • Even the docs box is just a web app — reverse proxy, runtime, database — and a good one to learn on.