Writing documentation for your house

The author, a first-time homeowner and engineer, suggests that writing technical documentation for houses would be beneficial. They mention having numerous questions about their house and realizing the need for a user manual-like documentation. The author recommends using the Diátaxis framework to organize documentation into tutorials, how-to guides, technical reference, and explanations. They also stress the importance of maintaining a changelog to record important changes to the house. The author’s personal implementation involves using Material for Mkdocs to create a website for documentation. They provide a directory structure example and a suggested mkdocs.yml configuration. The author concludes that having a centralized place for information improves their family’s quality of life and adds value to their home. They also mention the possibility of sharing the documentation with future owners.

https://luke.hsiao.dev/blog/housing-documentation/

To top