Documentation Without Assumption
Why good documentation means caring about your audience and stating the obvious. How assumption-free writing prevents confusion and creates better developer experiences.
Documentation
A Weekend With PostgreSQL
Live-streaming a deep dive through PostgreSQL documentation. Reading through the complete PostgreSQL docs over a weekend to explore one of the best-documented OSS projects.
How to Write Documentation - The README.md File
A deep dive into crafting effective README files that serve tech-savvy audiences. Covering project naming, installation guides, screenshots, and what to include or exclude from your repository's front door.
The Importance of Documentation
Why documentation matters and how understanding your audience transforms how you write. From README files to Getting Started guides, every document serves different readers with different needs.
TIL: ABlog for Sphinx - Documentation as a Blog Platform
Today I learned about ABlog, a Sphinx extension that transforms documentation sites into powerful blogging platforms, combining technical writing with blog functionality.
TIL: Writing Man Pages, Haskell Open Source Lessons, Orger Tool, and IoT Development Platforms
Today I learned about writing proper man pages, lessons from 14 years of Haskell open source development, the Orger tool for converting data to org-mode, and modern IoT development platforms.
TIL: Curated Development Resources and Learning Paths
Today I learned about comprehensive curated lists of development resources, learning curricula, and specialized tools covering everything from CSS protips to computer science fundamentals and documentation systems.
TIL: Documentation Systems and Educational Resources
Today I learned about effective documentation systems, comprehensive learning resources for computer science, and modern educational platforms from my archive.