Rédiger la documentation de votre maison

Rédiger une documentation technique pour son logement

Motivation

• En tant que primo-accédant, prise de conscience du besoin d'une documentation de référence pour répondre à diverses questions
• Mise en avant de l'importance d'un manuel utilisateur et d'une documentation technique pour le logement

Framework recommandé

• Envisager l'application du framework de documentation technique Diátaxis
• Structurer la documentation en quatre types : tutoriels, guides pratiques, références techniques et explications

Modifications

• Ajout d'une page de journal des modifications pour consigner les changements importants pendant la période de propriété du logement

Mise en œuvre

• Au lieu de créer un site web complexe, il est possible d'utiliser un simple classeur, Google Docs, une chaîne YouTube, etc.
• Personnellement, utilisation de Material for Mkdocs pour construire un site de documentation

Structure des répertoires

• Présentation d'un exemple de structure de répertoires incluant contrats, diagrammes, documents, finances, inspections, assurances, taxes, services publics, etc.

Configuration Mkdocs

• Fourniture d'un exemple de configuration mkdocs.yml, avec le nom du site, le thème, les plugins et les extensions Markdown

Prévisualisation locale

• Exécution de commandes avec Justfile pour prévisualiser localement la documentation

Conclusion

• Grâce à la documentation, amélioration de la qualité de vie en permettant à la famille de trouver facilement les informations nécessaires
• Mise en avant de l'importance d'augmenter la valeur du logement et de transmettre la documentation au propriétaire suivant

L'avis de GN⁺

Le point le plus important de cet article est qu'il propose aux propriétaires une méthode pour rédiger une documentation technique sur leur maison afin de retrouver et gérer facilement les informations. Une telle approche peut rendre la gestion du logement plus structurée et plus efficace, et elle est particulièrement utile en cas d'urgence ou lorsqu'une maintenance importante est nécessaire. L'article offre une idée originale qui applique les principes de l'ingénierie logicielle à la vie quotidienne, ce qui peut constituer une source d'inspiration intéressante pour les lecteurs.

[GN⁺]

Commentaire Hacker News

• Expérience d’un ami : pendant la pandémie, un ami rénovait sa maison et essayait de garder le lien avec les autres via un livestream. Un jour, en démolissant le mur de la salle de bain, il a trouvé entre les cloisons un clipboard contenant une liste du câblage électrique et des installations rédigée dans les années 70. Sur la première page, il y avait une note disant que les travaux de rénovation peuvent être durs et solitaires, mais qu’en continuant, cela en vaudra un jour la peine ; cela a ému mon ami et les spectateurs.
• Expérience de documentation de la maison : j’ai transformé la maison en smart home et créé tous les manuels et vidéos pour les transmettre au nouveau propriétaire, mais celui-ci semble avoir supprimé la plupart des fonctionnalités de smart home et ignoré la documentation. Depuis, j’ai décidé de ne plus investir le même effort dans la documentation de la maison.
• Expérience de vente d’une maison à Seattle : j’ai rénové mon ancienne maison et laissé une documentation détaillée, mais le nouveau propriétaire l’a ignorée. Plus tard, quand mon fils est passé, il a découvert que le four en briques que j’avais construit avait été démoli, ce qui m’a déçu. Malgré cela, je continuerai à documenter les maisons à l’avenir.
• Valeur de la documentation : grâce aux quelques documents laissés par l’ancien propriétaire, j’ai pu facilement comprendre l’historique de la maison et les informations de maintenance, ce qui est très utile pour un primo-accédant.
• Documentation via un wiki : je documente tout dans un wiki afin de faciliter la maintenance et une future vente de la maison. Les futurs propriétaires m’en seront aussi reconnaissants.
• Rédaction d’un « livre de la maison » : je tiens un carnet où je note toutes les informations liées à la maison, afin de retrouver facilement ce qu’il faut pour l’entretien.
• Importance de la documentation : si un membre de la famille décède soudainement ou perd ses capacités, des informations documentées peuvent être extrêmement utiles. Lorsqu’on documente, il vaut mieux utiliser des outils ou des supports compréhensibles même pour des non-spécialistes.
• Expérience de documentation d’un RV : je rédige une documentation détaillée de toutes les installations et de toute la maintenance du RV et de la maison, ce qui facilite leur gestion.
• Connaissance qu’a mon père de la conception de la maison : je vis dans une maison conçue par mon père, et comme il en a une connaissance détaillée, c’est une ressource précieuse.
• Rappel sur l’importance de documenter : plutôt que de viser la perfection, mieux vaut laisser ne serait-ce que quelques notes que de ne rien documenter du tout.