टेक्निकल राइटर कैसे बनें

छोटे वाक्य, कर्तृवाच्य, हर पैराग्राफ़ में एक ही विचार। Google का Tech Writing Course इंडस्ट्री में सबसे ज़्यादा माना जाने वाला शुरुआती कोर्स है।

• कोर्स मुफ़्त Google Technical Writing →
• किताब पेड On Writing Well (Zinsser) →

Microsoft, Google और IBM की स्टाइल गाइड इंडस्ट्री के मानक हैं। इनमें से कोई एक चुनें और उसका पूरी निष्ठा से पालन करें।

• डॉक्स मुफ़्त Microsoft Writing Style Guide →
• डॉक्स मुफ़्त Google Developer Documentation Style Guide →

Diátaxis डॉक्यूमेंटेशन का आधुनिक फ़्रेमवर्क है। हर प्रकार के कंटेंट के नियम, पाठक और ढाँचा अलग-अलग होते हैं।

• डॉक्स मुफ़्त Diátaxis Framework →
• डॉक्स मुफ़्त Diátaxis →

REST API का वर्णन करने का इंडस्ट्री मानक। स्पेसिफ़िकेशन पढ़ना, उसमें योगदान देना और उससे डॉक्यूमेंटेशन बनाना सीखें।

• डॉक्स मुफ़्त OpenAPI Specification →
• डॉक्स मुफ़्त Redocly Docs (best-in-class OpenAPI renderer) →

शुरुआत करने की गाइड, ऑथेंटिकेशन, एंडपॉइंट, एरर कोड, रेट लिमिट, चेंजलॉग। Stripe, Twilio और Plaid के डॉक्यूमेंटेशन का अध्ययन करें — यही पैमाना हैं।

• डॉक्स मुफ़्त Stripe API Reference (gold standard) →
• डॉक्स मुफ़्त Twilio Docs →

किसी एक काम पर केंद्रित, चरण-दर-चरण और चलने वाले कोड के साथ। अगर पाठक ट्यूटोरियल एक बार में बैठकर पूरा न कर सके, तो वह बहुत लंबा है।

• डॉक्स मुफ़्त Divio — Tutorials →
• डॉक्स मुफ़्त DigitalOcean Tutorials (reference bar) →

'क्यों' समझाने वाले डॉक्यूमेंट — डायग्राम, पृष्ठभूमि और ट्रेड-ऑफ़। अक्सर ये सबसे ज़्यादा असर डालते हैं, फिर भी सबसे कम लिखे जाते हैं।

• डॉक्स मुफ़्त Diátaxis — Explanation →

Docusaurus, MkDocs, Sphinx, VitePress, Nextra। आजकल डॉक्स-ऐज़-कोड ही चलन है — अपना स्टैक इंजीनियरिंग टीम की प्रोग्रामिंग भाषा के हिसाब से चुनें।

• डॉक्स मुफ़्त Docusaurus →
• डॉक्स मुफ़्त MkDocs →
• डॉक्स मुफ़्त Sphinx →

डॉक्यूमेंटेशन लिखने के तीन प्रमुख फ़ॉर्मेट। इंटरैक्टिव डॉक्यूमेंटेशन के लिए MDX (Markdown + JSX) सबसे ज़्यादा इस्तेमाल होता है।

• डॉक्स मुफ़्त MDX →
• डॉक्स मुफ़्त CommonMark →

ब्रांच, PR, कोड रिव्यू। डॉक्स-ऐज़-कोड का मतलब है कि लेखक भी इंजीनियरिंग वाले वर्कफ़्लो अपनाते हैं।

• ट्यूटोरियल मुफ़्त Learn Git Branching →

संरचना, नेविगेशन और जानकारी आसानी से ढूँढ पाना। डॉक्यूमेंटेशन के लिए कार्ड सॉर्टिंग। श्रेणी, प्रोडक्ट या काम के आधार पर समूह बनाना।

• डॉक्स मुफ़्त NN/g — Information Architecture →

किन पेजों पर ट्रैफ़िक आता है, यूज़र कहाँ छोड़कर चले जाते हैं, किन सर्च पर कोई नतीजा नहीं मिलता। सुधार के लिए पहले मापें।

• चैनल मुफ़्त Write the Docs Community →

जो आप समझते नहीं, उसे डॉक्यूमेंट नहीं कर सकते। इतनी प्रोग्रामिंग समझ ज़रूरी है कि जिस सोर्स कोड के बारे में लिख रहे हैं, उसे पढ़ सकें।

• ट्यूटोरियल मुफ़्त Exercism (learn languages via exercises) →

डॉक्यूमेंटेशन उसी रिपॉज़िटरी में रहता है जिसमें कोड। रिव्यू के ज़रिए डॉक्यूमेंटेशन की गुणवत्ता बनाए रखना अब आम चलन है।

• डॉक्स मुफ़्त Google Engineering Practices — Code Review →

ब्लॉग पोस्ट, लॉन्च की घोषणाएँ, कॉन्फ़्रेंस टॉक। टेक्निकल राइटर अक्सर DevRel की ओर भी बढ़ जाते हैं।

• ब्लॉग मुफ़्त Developer Relations →

प्रोडक्ट के अंदर के टेक्स्ट, एरर मैसेज, खाली स्क्रीन पर दिखने वाले संदेश। यह लंबे डॉक्यूमेंटेशन से अलग एक खास कला है।

• डॉक्स मुफ़्त UX Writing Hub →

पहला ड्राफ़्ट जल्दी तैयार करना, स्टाइल गाइड का पालन करवाना, अनुवाद। AI न्यूनतम स्तर ऊपर उठाता है; शिखर तक आपकी लेखन-कला ही ले जाती है।

• कोर्स मुफ़्त DeepLearning.AI Short Courses →

जहाँ कामकाजी टेक्निकल राइटर आपस में जुड़ते और चर्चा करते हैं।

• चैनल मुफ़्त Write the Docs (Slack + conferences) →
• ब्लॉग मुफ़्त I'd Rather Be Writing (Tom Johnson) →
• ब्लॉग मुफ़्त Passo.uno (Fabrizio Ferri Benedetti) →