अपने घर के लिए दस्तावेज़ लिखना

आवास के लिए तकनीकी दस्तावेज़ बनाना

प्रेरणा

• पहली बार घर के मालिक बनने पर विभिन्न सवालों के लिए दस्तावेज़ित संदर्भ सामग्री की आवश्यकता महसूस हुई
• घर के लिए user manual और तकनीकी दस्तावेज़ों के महत्व पर ज़ोर

सुझाया गया framework

• Diátaxis तकनीकी दस्तावेज़ framework को अपनाने पर विचार
• दस्तावेज़ों को चार प्रकारों में व्यवस्थित करना: tutorial, how-to guide, technical reference, और explanation

बदलाव

• घर के स्वामित्व की अवधि के दौरान हुए महत्वपूर्ण बदलावों को दर्ज करने के लिए बदलावों का एक पेज जोड़ना

कार्यान्वयन

• जटिल वेबसाइट लागू करने के बजाय साधारण binder, Google Docs, YouTube चैनल आदि का उपयोग किया जा सकता है
• व्यक्तिगत रूप से Material for Mkdocs का उपयोग करके documentation site बनाई गई

डायरेक्टरी संरचना

• contracts, diagrams, documents, finance, inspection, insurance, tax, utilities आदि को शामिल करने वाली उदाहरण डायरेक्टरी संरचना प्रस्तुत

Mkdocs सेटअप

• mkdocs.yml कॉन्फ़िगरेशन उदाहरण दिया गया है, जिसमें site name, theme, plugin, और Markdown extension शामिल हैं

लोकल प्रीव्यू

• Justfile का उपयोग करके लोकल में दस्तावेज़ प्रीव्यू के लिए कमांड चलाना

निष्कर्ष

• दस्तावेज़ीकरण के ज़रिए परिवार के लिए आवश्यक जानकारी को आसानी से ढूँढ़ पाने की गुणवत्ता में सुधार का अनुभव
• घर के मूल्य को बढ़ाने और अगले मालिक को दस्तावेज़ सौंपने के महत्व पर ज़ोर

GN⁺ की राय

इस लेख का सबसे महत्वपूर्ण बिंदु यह है कि इसमें घर के मालिकों को अपने घर के लिए तकनीकी दस्तावेज़ तैयार करने का तरीका बताया गया है, ताकि जानकारी को आसानी से खोजा और प्रबंधित किया जा सके। ऐसा दृष्टिकोण घर के प्रबंधन को अधिक व्यवस्थित और कुशल बना सकता है, और विशेष रूप से आपातकालीन स्थिति या महत्वपूर्ण maintenance की ज़रूरत पड़ने पर उपयोगी है। यह लेख software engineering के सिद्धांतों को रोज़मर्रा के जीवन में लागू करने का एक नया विचार देता है, जो पाठकों को दिलचस्प प्रेरणा दे सकता है।

[GN⁺]

Hacker News राय

• एक दोस्त का अनुभव: महामारी के दौरान एक दोस्त ने घर का नवीनीकरण करते हुए लाइवस्ट्रीम के जरिए लोगों से जुड़ने की कोशिश की। एक दिन बाथरूम की दीवार तोड़ते समय उसे दीवारों के बीच 70 के दशक में लिखी गई बिजली की वायरिंग और इंस्टॉलेशन सूची वाला एक clipboard मिला। clipboard के पहले पेज पर एक नोट था कि नवीनीकरण का काम कठिन और अकेलापन भरा हो सकता है, लेकिन लगे रहो तो एक दिन यह सार्थक होगा; इसने उस दोस्त और दर्शकों दोनों को भावुक कर दिया।
• घर का दस्तावेज़ीकरण करने का अनुभव: घर को smart home में बदलकर सभी manuals और videos बनाकर नए मालिक को दिए, लेकिन लगता है कि नए मालिक ने smart home की ज़्यादातर सुविधाएँ हटा दीं और दस्तावेज़ों को नज़रअंदाज़ कर दिया। उसके बाद तय किया कि घर के दस्तावेज़ीकरण में अब पहले जैसा प्रयास नहीं करेंगे।
• Seattle में घर बेचने का अनुभव: पिछला घर renovate किया और विस्तृत दस्तावेज़ छोड़े, लेकिन नए मालिक ने उन्हें नज़रअंदाज़ किया। बाद में जब बेटा मिलने गया, तो उसने देखा कि अपने हाथों से बनाया गया ईंटों का oven हटा दिया गया था, जिससे निराशा हुई। फिर भी आगे भी घर का दस्तावेज़ीकरण जारी रखेंगे।
• दस्तावेज़ीकरण का मूल्य: पिछले मालिक द्वारा छोड़े गए साधारण दस्तावेज़ों की वजह से घर के इतिहास और maintenance की जानकारी आसानी से समझी जा सकी, और यह पहली बार घर खरीदने वाले व्यक्ति के लिए बहुत उपयोगी था।
• wiki के जरिए दस्तावेज़ीकरण: हर चीज़ को wiki में दस्तावेज़ित किया जाता है ताकि maintenance और भविष्य में घर बेचने की प्रक्रिया आसान हो। भविष्य के मालिक भी इसके लिए आभारी होंगे।
• 'घर की किताब' लिखना: घर से जुड़ी सारी जानकारी दर्ज करने वाली एक notebook बनाई जाती है ताकि maintenance के लिए ज़रूरी जानकारी आसानी से मिल सके।
• दस्तावेज़ीकरण का महत्व: अगर परिवार में कोई अचानक गुजर जाए या काम करने की क्षमता खो दे, तो दस्तावेज़ित जानकारी बहुत उपयोगी हो सकती है। दस्तावेज़ीकरण करते समय ऐसे tools या माध्यम इस्तेमाल करना बेहतर है जिन्हें आम लोग भी समझ सकें।
• RV दस्तावेज़ीकरण का अनुभव: RV और घर में की गई सभी installations और maintenance के बारे में विस्तृत दस्तावेज़ तैयार किए गए ताकि प्रबंधन आसान हो सके।
• पिता के घर-डिज़ाइन ज्ञान: एक ऐसे घर में रह रहे हैं जिसे पिता ने डिज़ाइन किया था, और पिता के पास घर के बारे में विस्तृत ज्ञान है, जो एक उपयोगी संसाधन है।
• दस्तावेज़ीकरण के महत्व पर ज़ोर: पूर्णता के पीछे भागने के बजाय, साधारण नोट्स छोड़ देना भी बिल्कुल दस्तावेज़ न होने से बेहतर है।