All posts
Web & Frontend
· 1 min read · ↗ luke.hsiao.dev
Housing Documentation and Diátaxis
I ran across this post by someone who created technical documentation for their house. It’s an unusual concept, but the idea makes sense: when you own a property as complex as a home, there is a tremendous amount of information and maintenance history to track.
Setting aside the house aspect, reading it introduced me to a couple of interesting tools and frameworks:
- Structured documentation frameworks: The author organizes documentation using Diátaxis. It’s a compelling read because it tackles common organizational challenges and offers a clear, opinionated taxonomy for documentation (tutorials, how-to guides, reference, and explanation).
- Modern documentation generators: He used MkDocs paired with the Material for MkDocs theme to build documentation styled with Material Design. The UI elements and navigation look remarkably clean, making it a great candidate for visually appealing developer and API documentation.