Eviniz Hakkında Dokümantasyon Yazmak

Konut için teknik dokümantasyon hazırlamak

Motivasyon

• İlk kez ev sahibi olan biri olarak çeşitli sorular için dokümante edilmiş bir başvuru kaynağına duyulan ihtiyacın fark edilmesi
• Ev için kullanıcı kılavuzu ve teknik dokümantasyonun öneminin vurgulanması

Önerilen çerçeve

• Diátaxis teknik dokümantasyon çerçevesinin uygulanmasının değerlendirilmesi
• Dokümanların öğreticiler, nasıl yapılır rehberleri, teknik referanslar ve açıklamalar olmak üzere dört türe ayrılması

Değişiklikler

• Ev sahipliği süresi boyunca önemli değişiklikleri kaydetmek için bir değişiklikler sayfası eklenmesi

Uygulama

• Karmaşık bir web sitesi kurmak yerine basit bir klasör, Google Dokümanlar, YouTube kanalı vb. kullanılabilir
• Kişisel olarak dokümantasyon sitesi kurmak için Material for MkDocs kullanılması

Dizin yapısı

• Sözleşmeler, diyagramlar, belgeler, finans, incelemeler, sigorta, vergiler, kamu hizmetleri vb. içeren örnek bir dizin yapısının sunulması

MkDocs yapılandırması

• Site adı, tema, eklentiler ve Markdown uzantılarını içeren mkdocs.yml yapılandırma örneğinin verilmesi

Yerel önizleme

• Justfile kullanılarak dokümanları yerelde önizlemek için komutların çalıştırılması

Sonuç

• Dokümantasyon sayesinde ailenin ihtiyaç duyduğu bilgileri kolayca bulabilmesiyle kalite artışı yaşanması
• Evin değerini artırma ve dokümanları bir sonraki sahibine devretmenin öneminin vurgulanması

GN⁺ görüşü

Bu yazıdaki en önemli nokta, ev sahiplerinin kendi evleri için teknik dokümantasyon hazırlayarak bilgiyi kolayca bulup yönetebilecekleri bir yöntem sunmasıdır. Bu yaklaşım, ev yönetimini daha sistematik ve verimli hale getirebilir; özellikle acil durumlarda veya önemli bakım gerektiğinde faydalıdır. Yazı, yazılım mühendisliği ilkelerini günlük yaşama uygulayan özgün bir fikir sunuyor ve bu da okurlara ilham verebilir.

[GN⁺]

Hacker News görüşü

• Bir arkadaşın deneyimi: Arkadaşı pandemi sırasında evini yenilerken canlı yayın üzerinden insanlarla bağlantı kurmaya çalıştı. Bir gün banyo duvarını yıkarken, duvarların arasında 70'lerde hazırlanmış elektrik tesisatı ve kurulum listesini içeren bir pano buldu. Panonun ilk sayfasında, yenileme işinin zor ve yalnız hissettirebileceği ama devam edilirse bir gün buna değeceğine dair bir not vardı; bu da arkadaşını ve izleyicileri duygulandırdı.
• Ev dokümantasyonu deneyimi: Evi akıllı eve dönüştürüp tüm kılavuzları ve videoları yeni sahibine teslim etti, ancak yeni sahibin akıllı ev özelliklerinin çoğunu kaldırdığı ve belgeleri görmezden geldiği anlaşıldı. Bu yüzden artık ev için dokümantasyona aynı emeği harcamamaya karar verdi.
• Seattle'da ev satma deneyimi: Önceki evini yenileyip ayrıntılı belgeler bıraktı, ancak yeni sahibi bunları dikkate almadı. Daha sonra oğlu ziyarete gittiğinde, kendi yaptığı tuğla fırının söküldüğünü görüp hayal kırıklığına uğradı. Buna rağmen gelecekte de evle ilgili dokümantasyon yapmayı sürdürecek.
• Dokümantasyonun değeri: Önceki ev sahibinin bıraktığı basit belgeler sayesinde evin geçmişi ve bakımıyla ilgili bilgileri kolayca anlayabildi; bu da ilk kez ev alan biri için çok faydalı oldu.
• Wiki ile dokümantasyon: Her şeyi bir wiki'de belgeleyerek bakım işlerini ve gelecekte evi satmayı kolaylaştırıyor. Gelecekteki sahipler de bunun için minnettar olacaktır.
• 'Ev kitabı' hazırlama: Evle ilgili tüm bilgilerin kaydedildiği bir defter hazırlayarak bakım için gerekli bilgilere kolayca ulaşılmasını sağlıyor.
• Dokümantasyonun önemi: Aileden biri aniden vefat ettiğinde ya da yetilerini kaybettiğinde, belgelenmiş bilgiler çok faydalı olabilir. Dokümantasyon yaparken sıradan insanların da anlayabileceği araçlar veya ortamlar kullanmak iyi olur.
• RV dokümantasyonu deneyimi: RV ve evdeki tüm kurulumlar ile bakım işleri hakkında ayrıntılı belgeler hazırlayarak yönetimi kolaylaştırıyor.
• Babanın ev tasarımı bilgisi: Babasının tasarladığı bir evde yaşıyor ve babası ev hakkında ayrıntılı bilgiye sahip olduğu için faydalı bir kaynak.
• Dokümantasyonun önemine vurgu: Mükemmelliği hedeflemek yerine, basit notlar bile bırakmanın hiç dokümantasyon olmamasından daha iyi olduğu görüşü dile getiriliyor.