Writing a useful README

Writing a useful README को समझें

Writing a useful README में पहले यह समझें कि वह कौन-सी समस्या हल करता है। Tool या workflow चुनने से पहले input, constraint और दिखने वाला result पहचानें। इससे आपका निर्णय समझाना और review करना आसान होगा।

काम करने का path देखें

Writing a useful README का अभ्यास इस path से करें: context समझें, एक focused बदलाव करें, result verify करें और फिर सीख लिखें।

एक उपयोगी तुलना

Writing a useful README यात्रा से पहले की checklist जैसा है: वह आपके लिए यात्रा नहीं कर सकता, लेकिन छोटी छूटी बात को महँगे surprise बनने से रोकता है।

Action के पीछे की reasoning जाँचें।

त्वरित जाँच: Writing a useful README का उपयोग करते समय सबसे मजबूत पहला step क्या है?

• समस्या, constraint और सफलता का evidence तय करें।
• बिना पढ़े सबसे बड़ा example copy करें।
• समय बचाने के लिए verification छोड़ दें।