Documentación para tu casa

Cómo crear documentación técnica para una vivienda

Motivación

• Como propietario de una primera vivienda, reconocer la necesidad de contar con referencias documentadas para distintas preguntas
• Destacar la importancia de tener un manual de usuario y documentación técnica sobre la vivienda

Marco de trabajo recomendado

• Considerar aplicar el marco de documentación técnica Diátaxis
• Organizar la documentación en cuatro tipos: tutoriales, guías prácticas, referencia técnica y explicaciones

Cambios

• Agregar una página de cambios para registrar modificaciones importantes durante el período de propiedad de la vivienda

Implementación

• En lugar de implementar un sitio web complejo, se puede usar una carpeta física simple, Google Docs, un canal de YouTube, etc.
• A nivel personal, se usa Material for Mkdocs para construir un sitio de documentación

Estructura de directorios

• Se presenta una estructura de directorios de ejemplo que incluye contratos, diagramas, documentos, finanzas, inspecciones, seguros, impuestos y servicios públicos, entre otros

Configuración de Mkdocs

• Se proporciona un ejemplo de configuración de mkdocs.yml, incluyendo nombre del sitio, tema, plugins y extensiones de Markdown

Vista previa local

• Usar Justfile para ejecutar comandos y previsualizar la documentación localmente

Conclusión

• La documentación mejora la calidad de vida al permitir que la familia encuentre fácilmente la información que necesita
• Se destaca la importancia de aumentar el valor de la vivienda y de entregar la documentación al siguiente propietario

Opinión de GN⁺

Lo más importante de este texto es que propone que los propietarios creen documentación técnica sobre su propia casa para poder encontrar y gestionar la información con facilidad. Este enfoque puede hacer que la administración del hogar sea más sistemática y eficiente, y resulta especialmente útil en emergencias o cuando se necesita mantenimiento importante. El texto ofrece una idea novedosa al aplicar principios de ingeniería de software a la vida cotidiana, lo que puede dar a los lectores una inspiración interesante.

[GN⁺]

Opinión de Hacker News

• Experiencia de un amigo: durante la pandemia, un amigo remodeló su casa e intentó conectarse con otras personas mediante transmisiones en vivo. Un día, mientras demolía la pared del baño, encontró entre los muros un portapapeles de los años 70 con el cableado eléctrico y una lista de instalaciones. En la primera página había una nota que decía que la remodelación podía ser dura y solitaria, pero que si seguía adelante algún día valdría la pena; eso conmovió tanto a mi amigo como a quienes lo veían.
• Experiencia documentando una casa: convertí mi casa en un hogar inteligente e hice todos los manuales y videos para entregárselos al nuevo dueño, pero parece que el nuevo propietario eliminó la mayoría de las funciones inteligentes e ignoró la documentación. Desde entonces decidí no volver a invertir el mismo esfuerzo en documentar una casa.
• Experiencia al vender una casa en Seattle: remodelé mi casa anterior y dejé documentación detallada, pero el nuevo dueño la ignoró. Más tarde, cuando mi hijo fue de visita, descubrió que habían demolido el horno de ladrillo que yo había construido, lo que fue decepcionante. Aun así, seguiré documentando las casas en el futuro.
• El valor de la documentación: gracias a unos documentos simples que dejó el dueño anterior, fue fácil entender la historia de la casa y la información de mantenimiento, algo muy útil para quien compra su primera vivienda.
• Documentación mediante un wiki: documento todo en un wiki para facilitar el mantenimiento y una futura venta de la casa. Los futuros propietarios también lo agradecerán.
• Escribir un "libro de la casa": llevar una libreta con toda la información relacionada con la casa para que sea fácil encontrar lo necesario para el mantenimiento.
• La importancia de documentar: si alguien de la familia fallece repentinamente o pierde sus capacidades, la información documentada puede ser muy útil. Al documentar, conviene usar herramientas o medios que incluso una persona común pueda entender.
• Experiencia documentando una RV: redacté documentación detallada de todas las instalaciones y del mantenimiento tanto de la RV como de la casa para facilitar su gestión.
• Conocimiento del padre sobre el diseño de la casa: vivo en una casa diseñada por mi padre, y él tiene un conocimiento detallado de la vivienda, así que es un recurso muy útil.
• Énfasis en la importancia de documentar: se plantea que, en vez de buscar la perfección, incluso dejar notas simples es mejor que no documentar nada.