मानक
तकनीकी प्रलेखन में सुलभ कोड उदाहरण और तालिकाएँ
दस्तावेज़ीकरण में सुलभता केवल नेविगेशन और कॉन्ट्रास्ट तक सीमित नहीं है। कोड उदाहरण, JSON प्रतिक्रियाएँ और संदर्भ तालिकाएँ भी बिना केवल रंग पर निर्भर हुए समझ में आनी चाहिए।
7 मिनट
लेखन
टैग वाले लेख: लेखन
API
API examples workflow सिखाएँ, reference page सजाएँ नहीं
Technically valid request जरूरी नहीं कि useful example हो। Realistic values और ऐसी sequence चुनें जो API का mental model दिखाए और developer को अगला कदम समझने दे। Schema से निकला example syntactically correct हो सकता है लेकिन कुछ सिखाए नहीं। string, 123 और foo validator pass कर लेते हैं, पर domain meaning छिपा देते हैं। अच्छा example बताता है कि request क्यों है और success के बाद क्या किया जा सकता है…
4 मिनट
API
ऐसी authentication documentation जो support tickets घटाए
“ऐसी authentication documentation जो support tickets घटाए” पर एक व्यावहारिक और जाँच योग्य मार्गदर्शिका, जिसे documentation team लंबे समय तक बनाए रख सके। “ऐसी authentication documentation जो support tickets घटाए” को तकनीकी दस्तावेज़ीकरण के लिए व्यावहारिक, जाँच योग्य और टिकाऊ तरीके से समझाया गया है। शुरुआत में वास्तविक उपयोगकर्ता समस्या को टीम की आंतरिक पसंद से अलग करें और ऐसी शर्तें लिखें जि…
6 मिनट
सीखना
2026 में technical writer को क्या पढ़ना चाहिए: जीवित guides और अब भी उपयोगी किताबें
अच्छी reading list अब केवल classic books की सूची नहीं है। Microsoft, Google, GitHub और IBM की active guidance की तुलना करें, Diátaxis से structure जाँचें और हर reading session को real documentation exercise में बदलें।
5 मिनट
सीखना
Technical writers के लिए deliberate practice: काम को train करें, buzzwords को नहीं
Documentation के बारे में पढ़ना उपयोगी है, पर skills तेजी से बढ़ती हैं जब आप research, restructuring, editing और verification के छोटे exercises feedback के साथ बार-बार करते हैं। “Technical writing बेहतर करना” बहुत broad है। एक capability चुनें: ambiguity कम करना, procedure design करना, engineer interview करना, API example edit करना, navigation restructure करना या terminology बनाना।
3 मिनट
टूल्स
Diagrams as code: कब उपयोगी, कब नहीं
“Diagrams as code: कब उपयोगी, कब नहीं” पर एक व्यावहारिक और जाँच योग्य मार्गदर्शिका, जिसे documentation team लंबे समय तक बनाए रख सके। “Diagrams as code: कब उपयोगी, कब नहीं” को तकनीकी दस्तावेज़ीकरण के लिए व्यावहारिक, जाँच योग्य और टिकाऊ तरीके से समझाया गया है। शुरुआत में वास्तविक उपयोगकर्ता समस्या को टीम की आंतरिक पसंद से अलग करें और ऐसी शर्तें लिखें जिन्हें पाठक बिना आंतर…
6 मिनट
API
API errors को इस तरह लिखें कि developer recover कर सके
“API errors को इस तरह लिखें कि developer recover कर सके” पर एक व्यावहारिक और जाँच योग्य मार्गदर्शिका, जिसे documentation team लंबे समय तक बनाए रख सके। “API errors को इस तरह लिखें कि developer recover कर सके” को तकनीकी दस्तावेज़ीकरण के लिए व्यावहारिक, जाँच योग्य और टिकाऊ तरीके से समझाया गया है। शुरुआत में वास्तविक उपयोगकर्ता समस्या को टीम की आंतरिक पसंद से अलग करें और ऐसी शर्तें लिखें जिन्…
6 मिनट
API
REST API को सही तरह document कैसे करें
अच्छी API documentation machine-readable contract, मानवीय explanation, runnable examples और स्पष्ट error behavior को जोड़ती है। REST API documentation की दो audiences हैं: machine और human.
3 मिनट
सीखना
Editing drills जो technical writing को तेजी से सुधारें
“Editing drills जो technical writing को तेजी से सुधारें” पर एक व्यावहारिक और जाँच योग्य मार्गदर्शिका, जिसे documentation team लंबे समय तक बनाए रख सके। “Editing drills जो technical writing को तेजी से सुधारें” को तकनीकी दस्तावेज़ीकरण के लिए व्यावहारिक, जाँच योग्य और टिकाऊ तरीके से समझाया गया है। शुरुआत में वास्तविक उपयोगकर्ता समस्या को टीम की आंतरिक पसंद से अलग करें और ऐसी शर्तें लिखें जिन्…
6 मिनट
टूल्स
बड़े पैमाने पर Markdown: repository को अव्यवस्था से बचाने के नियम
“बड़े पैमाने पर Markdown: repository को अव्यवस्था से बचाने के नियम” पर एक व्यावहारिक और जाँच योग्य मार्गदर्शिका, जिसे documentation team लंबे समय तक बनाए रख सके। “बड़े पैमाने पर Markdown: repository को अव्यवस्था से बचाने के नियम” को तकनीकी दस्तावेज़ीकरण के लिए व्यावहारिक, जाँच योग्य और टिकाऊ तरीके से समझाया गया है। शुरुआत में वास्तविक उपयोगकर्ता समस्या को टीम की आंतरिक पसंद से अलग करें और ऐसी शर्तें…
6 मिनट
API
OpenAPI source of truth है, पूरी API documentation नहीं
OpenAPI description accurate reference structure generate कर सकती है, लेकिन developers को concepts, task flows, authentication, examples और failure recovery भी चाहिए जिन्हें schema अकेले नहीं समझा सकता। OpenAPI operations, parameters, request/response shapes, status codes और reusable schemas बहुत अच्छी तरह describe करता है। इसलिए generated reference और automated validation के लिए यह मजबूत source है।
4 मिनट
प्रैक्टिस
ऐसे release notes जिन पर उपयोगकर्ता कार्रवाई कर सके
“ऐसे release notes जिन पर उपयोगकर्ता कार्रवाई कर सके” पर एक व्यावहारिक और जाँच योग्य मार्गदर्शिका, जिसे documentation team लंबे समय तक बनाए रख सके। “ऐसे release notes जिन पर उपयोगकर्ता कार्रवाई कर सके” को तकनीकी दस्तावेज़ीकरण के लिए व्यावहारिक, जाँच योग्य और टिकाऊ तरीके से समझाया गया है। शुरुआत में वास्तविक उपयोगकर्ता समस्या को टीम की आंतरिक पसंद से अलग करें और ऐसी शर्तें लिखें जिन्हें…
6 मिनट