Technical writing को साफ़-सुथरे तरीके से पूरा करने के सिद्धांत

1. ज़रूरत से ज़्यादा औपचारिक शैली की बजाय रोज़मर्रा की बातचीत जैसी भाषा में लिखें.

2. लिखे हुए को ज़ोर से पढ़ें और जाँचें कि क्या वह 'वास्तव में किसी इंसान की बात' जैसा सुनाई देता है.

3. उपयोगकर्ता की रुचियाँ, विशेषताएँ, शिक्षा और अनुभव का स्तर, पढ़ने का समय और स्थान, तथा कामकाजी माहौल को ध्यान में रखें.

4. वही जानकारी चुनकर दें जो उपयोगकर्ता जानना चाहे या जिसे उसे वास्तव में ज़रूरत हो.

5. यह मानकर न चलें कि सभी उपयोगकर्ता product और उससे जुड़ी तकनीक को किसी expert जितना जानते हैं.

6. लेख प्रकाशित होने के बाद भी terminology, उपयोग के तरीके और feature changes को समय पर अपडेट करें.

7. अनावश्यक विशेषण, postposition और सहायक क्रियाओं का प्रयोग न करें.

8. दोहरे passive expressions का इस्तेमाल न करें.
   उदाहरण) ऐसे रूपों से बचें जो वाक्य को बेवजह जटिल या अप्राकृतिक बना दें.

9. 'कई/बहुत/विविध/सभी' जैसे शब्दों के बाद आने वाले शब्दों को अनावश्यक बहुवचन न बनाएं.

10. अगर technical term का इस्तेमाल ज़रूरी हो, तो उसी लेख में उसका अर्थ समझा दें.

11. यदि आप किसी खास industry या profession से जुड़े लोगों के लिए लिख रहे हैं, तो उसी क्षेत्र में प्रचलित शब्दावली का उपयोग करें.

12. लेख पूरा करने और थोड़ा विराम लेने के बाद उसे फिर से पढ़ें.

13. अगर आपने लेख desktop पर लिखा है, तो उसे smartphone या tablet PC पर पढ़ें. चाहें तो print निकालकर भी पढ़ सकते हैं.

14. लेख को ज़ोर से पढ़ें और सुनें कि वह कैसा लगता है.

15. जो वाक्य बोलने में असुविधाजनक हों या अटपटे लगें, उन्हें सुधारें.

16. reviewer से पूछें कि 'क्या लेख आसानी से समझ में आता है', 'क्या लेख का flow ठीक है', और 'क्या कुछ और जोड़ने की ज़रूरत है'. चाहें तो feedback के लिए और भी specific सवाल पूछ सकते हैं.

17. अगर लेख में किसी खास feature की चर्चा की है, तो यह test करें कि क्या वह feature लेख में बताए अनुसार काम करता है.

18. जाँचें कि 'feature, menu के नाम और screen पर दिखने वाली सामग्री' लेख में लिखी बातों से मेल खाती है या नहीं.

19. spell checker से टाइपो और spacing errors जाँचें.
    अनुशंसित tools: Pusan National University spell checker, Daum spell checker

20. National Institute of Korean Language की विदेशी शब्द वर्तनी संबंधी शैली-मार्गदर्शिका देखकर loanword spelling errors की जाँच करें.

[princox]

विदेशी शब्दों की वर्तनी की गलतियां सच में काफी बड़ी समस्या हैं,,
mesedeu, enjel जैसी चीज़ों को कई बार mesodeu, einjeol की तरह लिखना पड़ता है.

समस्या यह है कि "गलत वर्तनी" ही ज़्यादा इस्तेमाल होती है, और यहां तक कि उसका SEO भी अच्छा होता है.. यह सच में बेतुकी स्थिति है.

आखिर सही जवाब क्या है..? sob sob sob

[roxie]

मुझे लगता है कि समस्या उस notation में है जो वास्तविकता को ठीक से प्रतिबिंबित नहीं कर पाती।

[ah2dius]

https://meetup.nhncloud.com/posts/355

यह शायद अंतिम जवाब नहीं है, लेकिन रेफ़रेंस के तौर पर देखना उपयोगी हो सकता है~

[princox]

सही रूप में ये क्रमशः "method" और "Angel" के रूप में आ रहे हैं.
इसके अलावा, object के मामले में MS इसे "object" जैसे शुद्ध किए गए शब्द से भी लिखता है..

वाकई technical writing बहुत मुश्किल है.

[pugh123]

अच्छी सामग्री के लिए धन्यवाद।