Bir projeyi başka bilgisayarda açınca ilk soru çoğu zaman “bunu nasıl çalıştırıyoruz?” olur. Bu soruya yalnızca projeyi ilk kuran kişi yanıt verebiliyorsa bilgi tek kişide kalmış demektir. Kısa bir README dosyası, çalışma düzeninin görünür bir kaydı olabilir.
Gerçekten denenmiş adımları yazın
Ön koşulları, kurulum adımını ve uygulamayı başlatma yöntemini ayrı başlıklarda belirtin. Henüz çalıştırmadığınız bir komutu tamamlanmış talimat gibi eklemeyin. Projede hangi klasörde bulunulması gerektiği de açık olsun.
Özel anahtar veya parola yerine gerekli ayarın adını ve nereden güvenli biçimde sağlanacağını anlatın. Örnek yapılandırma ile gerçek çalışma dosyasını karıştırmayın. Başka bir kişinin belgeyi izlediğinde hangi ekranı görmesi gerektiğini yazmak kontrolü kolaylaştırır.
Bakım bilgisini unutmayın
Testlerin nasıl çalıştırıldığını ve veri değiştiren işlemlerin hangileri olduğunu belirtin. Bir komut örnek veriyi sıfırlıyorsa bunu belgenin içinde görünür şekilde açıklayın. Güncel olmayan talimat, hiç talimat olmaması kadar kafa karıştırabilir.
Sizin için iyi bir başlangıç README dosyasının en önemli üç bölümü hangileri? Gerçek erişim bilgileri olmadan başlık düzeninizi paylaşabilirsiniz. Projeyi birkaç hafta sonra kendiniz yeniden açtığınızda da aynı açıklıklara ihtiyaç duyabileceğinizi hesaba katın.
