यदि आप पर एक दस्तावेज लिखने का आरोप लगाया गया है जो किसी और को निर्देश देने के लिए माना जाता है कि कैसे कुछ करना है, तो इसे कम या ज्यादा करने का तरीका पुराने तरीकों को खिड़की से बाहर फेंक देता है।
1. बिग बॉम्बेस्टिक हेडर
आप PCMech पर हेडर को नोटिस करेंगे, जैसे कि इस वाक्य के ठीक ऊपर, बहुत बड़ा है। इसका कारण यह है कि आप दस्तावेज़ में देखना, पढ़ना और जानना आसान है।
2. कम शब्द
गलत रास्ता:
निम्नलिखित प्रलेखन बताता है कि फैनी वाकर 2000 का उपयोग और संचालन कैसे करें।
सही रास्ता:
फैनी वाकर 2000 का उपयोग करने के निर्देश
दस्तावेज लिखते समय इस वाक्यांश को हमेशा याद रखें: स्थिति के रूप में सबसे पहले लिखें।
3. बेकार संदर्भों को छोड़ दें
यदि संदर्भ का इस बात के मूल निर्देश से कोई लेना-देना नहीं है कि आप क्या वर्णन करने का प्रयास कर रहे हैं, जैसे:
फैनी Whacker 2000 के शलजम Twaddler के बारे में अधिक जानकारी के लिए, कृपया दस्तावेज़ FU, उपधारा ID10T देखें।
… ऐसा मत करो।
4. इसे डेट करें। हमेशा।
जब दस्तावेज़ लिखा गया था, तो हर पृष्ठ के पाद लेख क्षेत्र में होना चाहिए। यदि यह एक इलेक्ट्रॉनिक दस्तावेज है, तो तिथि दो बार दिखाई जाती है। एक बार शुरुआत में, एक बार अंत में।
आप इसे "अंतिम संशोधित (यहां तिथि डालें)" के रूप में लिख सकते हैं।
5. चेतावनी हमेशा बिना किसी रिटर्न के बिंदु से पहले पोस्ट की जानी चाहिए
यदि आपके दस्तावेज़ में कुछ ऐसा है जो गलत तरीके से प्रदर्शन करने पर किसी चीज़ को संभावित रूप से नुकसान / नष्ट / नष्ट कर सकता है, तो यह जानकारी सीधे निर्देश के बाद रखी जानी चाहिए, स्पष्ट दृष्टि (एक ही पृष्ठ पर अर्थ) और उच्चारण में हो।
उदाहरण:
चरण 5. फैनी वाकर 2000 की सफाई
FW2000 के पैडल को एक गैर-अपघर्षक नरम कपड़े का उपयोग करके धीरे से साफ किया जाना चाहिए।
चेतावनी: FW2000 को विस्फोट से रोकने के लिए केवल अमोनिया मुक्त विलायक का उपयोग करें और इसके परिणामस्वरूप आपकी असामयिक मृत्यु हो सकती है।
अंतिम नोट पर, अच्छा दस्तावेज़ीकरण हर एक संभव चीज़ के बारे में सुपर-वर्णनात्मक होने से नहीं है जो कल्पनाशील है। अपने दस्तावेज़ पढ़ें और अपने आप से पूछें, क्या यह ठीक से निर्देश देता है? यदि उत्तर हाँ है, तो अगला प्रश्न यह है कि क्या यह जल्दी से निर्देश देता है? यदि हाँ, तो प्रलेखन अच्छा है।
