Toss ने Technical Writing Guide जारी की
(technical-writing.dev)अच्छे तकनीकी दस्तावेज़ लिखने के मुख्य सिद्धांत
1. दस्तावेज़ का प्रकार तय करें
दस्तावेज़ के उद्देश्य के अनुसार अधिक प्रभावी ढंग से लिखने के तरीके अलग होते हैं।
- सीखने-केंद्रित दस्तावेज़: जब किसी नई तकनीक या टूल का पहली बार सामना हो, तो उसके समग्र प्रवाह को समझने के उद्देश्य से
- समस्या-समाधान दस्तावेज़: जब पृष्ठभूमि ज्ञान हो, तो किसी विशेष समस्या को हल करने के उद्देश्य से
- संदर्भ दस्तावेज़: जब उपयोग का तरीका पहले से पता हो, लेकिन किसी विशेष फीचर या API के उपयोग की पुष्टि करनी हो
- व्याख्यात्मक दस्तावेज़: अवधारणाओं, सिद्धांतों और पृष्ठभूमि ज्ञान को विस्तार से समझने के उद्देश्य से
2. जानकारी की संरचना बनाएं
नई जानकारी को समझने के लिए प्रयास की आवश्यकता होती है, लेकिन जानकारी को संरचित करने से यह प्रयास कम किया जा सकता है।
- एक पेज पर केवल एक विषय रखें
- पहले मूल्य प्रदान करें
- प्रभावी शीर्षक लिखें
- रूपरेखा देना न भूलें
- चीज़ों को पूर्वानुमेय बनाएं
3. वाक्यों को संवारें
अगर वाक्यों की संप्रेषण क्षमता बढ़ाई जाए, तो पाठक सामग्री को अधिक आसानी से समझ सकते हैं। अगर विवरण ऐसे वाक्यों में लिखा जाए जिन्हें समझना कठिन हो, तो संप्रेषण क्षमता काफी कम हो जाती है।
- वाक्य का कर्ता स्पष्ट रखें
- केवल ज़रूरी जानकारी ही रखें
- ठोस और विशिष्ट रूप से लिखें
- स्वाभाविक हिंदी अभिव्यक्ति का उपयोग करें
- एकरूपता बनाए रखें
6 टिप्पणियां
क्या Toss द्वारा बनाए गए ऐसे साइट्स को एक जगह इकट्ठा करके दिखाने वाली कोई जगह नहीं है?
'यो' शैली की आदत डालना मुश्किल है।
बिलकुल सही कहा।
अच्छा है, खासकर वाक्य-संपादन वाला हिस्सा few-shot के साथ GPTs में बनाकर इस्तेमाल करके देखना चाहिए।
मुझे लगता है कि इस तरह के लेख अच्छे होते हैं। LLM के दौर में ऐसे guidelines किस तरह बदल सकते हैं?
यह बहुत ही अच्छा प्रोजेक्ट है ^^