Diátaxis – तकनीकी दस्तावेज़ लेखन के लिए एक व्यवस्थित दृष्टिकोण

 (diataxis.fr)
3 पॉइंट द्वारा GN⁺ 2024-12-06 | 1 टिप्पणियां | WhatsApp पर शेयर करें
  • Diátaxis तकनीकी दस्तावेज़ लेखन के लिए एक व्यवस्थित दृष्टिकोण प्रस्तुत करता है। यह दृष्टिकोण दस्तावेज़ उपयोगकर्ताओं की ज़रूरतों को समझने के एक व्यवस्थित तरीके से शुरू होता है और content, structure और format के प्रति एक तरीका सुझाता है।
  • प्राचीन ग्रीक से निकला Diátaxis चार स्पष्ट ज़रूरतों और उनसे मेल खाने वाले दस्तावेज़ रूपों की पहचान करता है: ट्यूटोरियल, कैसे करें गाइड, तकनीकी संदर्भ, और व्याख्या। यह इन ज़रूरतों की संरचना के अनुसार दस्तावेज़ों को व्यवस्थित करने का प्रस्ताव करता है।
  • Diátaxis दस्तावेज़ के content (क्या लिखना है), style (कैसे लिखना है), और structure (कैसे व्यवस्थित करना है) से जुड़ी समस्याओं का समाधान करता है।
  • यह केवल दस्तावेज़ उपयोगकर्ताओं के लिए ही नहीं, बल्कि दस्तावेज़ लेखकों और maintainers के लिए भी मूल्यवान है। यह हल्का, समझने में आसान और लागू करने में सरल है। यह implementation constraints थोपता नहीं है, बल्कि दस्तावेज़ों की गुणवत्ता बढ़ाने के लिए सक्रिय सिद्धांत प्रदान करता है।

सामग्री

  • यह वेबसाइट Diátaxis को लागू करने और समझने में मदद करने वाले दो मुख्य sections में विभाजित है।

    • यहाँ से शुरू करें। ये पेज इस दृष्टिकोण को तुरंत और ठोस रूप से समझने में मदद करते हैं।
      • Diátaxis लागू करना
      • ट्यूटोरियल
      • कैसे करें गाइड
      • संदर्भ
      • व्याख्या
      • कंपास
      • वर्कफ़्लो
    • यह section Diátaxis के सिद्धांत और मूलभूत सिद्धांतों को अधिक गहराई से समझता है, और उन ज़रूरतों की समझ प्रस्तुत करता है जो इसे आधार देती हैं।
      • Diátaxis को समझना
      • बुनियाद
      • मानचित्र
      • गुणवत्ता
      • ट्यूटोरियल और कैसे करें गाइड
      • संदर्भ और व्याख्या
      • जटिल पदानुक्रम

  • Diátaxis व्यवहार में सिद्ध हो चुका एक सिद्धांत है। इसे सैकड़ों दस्तावेज़ परियोजनाओं में सफलतापूर्वक अपनाया गया है।

    • Gatsby में open source दस्तावेज़ों को पुनर्गठित करते समय Diátaxis framework को एक प्रमुख resource के रूप में इस्तेमाल किया गया। इसके चार quadrants हर दस्तावेज़ प्रकार के लिए उपयोगकर्ता के लक्ष्यों को प्राथमिकता देने में मदद करते हैं।
    • Cloudflare developer दस्तावेज़ों को फिर से डिज़ाइन करते समय Diátaxis सूचना संरचना का guiding star बन गया। नए content की जगह तय करते समय framework का संदर्भ लेने से दस्तावेज़ पाठकों और contributors दोनों के लिए अधिक स्पष्ट हो गए।

संबंधित पढ़ाई

1 टिप्पणियां

 
GN⁺ 2024-12-06
Hacker News की राय

  • एक उपयोगकर्ता ने कहा कि यह समझना महत्वपूर्ण है कि सारी जानकारी एक ही बार में देने की ज़रूरत नहीं होती। अलग-अलग पाठकों के लिए जानकारी को कई तरीकों से लिखना उपयोगी होता है

  • Sequin के दस्तावेज़ों में Diátaxis framework लागू करने से documentation का प्रवाह बेहतर हुआ। हालांकि, Diátaxis का अपना documentation कुछ हद तक कठिन और अनावश्यक रूप से लंबा बताया गया

    • इसे cooking उपकरण खरीदने की प्रक्रिया की उपमा से समझाया गया
      • पहले "quick start" tutorial के ज़रिए सामान्य उपयोग का तरीका देखा जाता है
      • किसी खास व्यंजन के लिए इसे कैसे इस्तेमाल करें, यह "how-to" होता है
      • और गहराई से जानना हो तो reference सामग्री देखी जाती है
      • अगर pressure cooking के वैज्ञानिक सिद्धांत समझने हों, तो explanatory सामग्री पढ़ी जाती है

  • तकनीकी दस्तावेज़ लिखने वालों ने कहा कि Diátaxis, DITA से मिलता-जुलता है। लेकिन यह उपयोगकर्ता की ज़रूरतों को नज़रअंदाज़ कर सकता है, और जानकारी के पुन: उपयोग के लिए उसे छोटे-छोटे हिस्सों में बाँटना पड़ता है

  • SwiftUI app विकसित करने वाले एक उपयोगकर्ता ने महसूस किया कि आधुनिक technical documentation को बहुत खराब तरीके से संभाला जा रहा है, और दस्तावेज़ों में maintainer और user दोनों दृष्टिकोणों पर विचार होना चाहिए

  • कहा गया कि Diátaxis दस्तावेज़ों को संरचित करने में उपयोगी है, लेकिन इसे बहुत सख्ती से लागू करना एक जाल बन सकता है

  • समझाया गया कि Diátaxis का असली मूल्य documentation लिखने के तरीके को सरल बनाने में है। हर उपयोगकर्ता की ज़रूरत के अनुसार दस्तावेज़ लिखना महत्वपूर्ण है

  • कहा गया कि divio का graphic ज़्यादा सहज है, लेकिन Diátaxis अधिक व्यापक documentation देता है

  • Diátaxis अपनाने के बाद technical documentation में बड़ा सुधार हुआ, और page ownership तथा नियमित review ने सफल documentation में योगदान दिया

  • कहा गया कि Diátaxis framework एक सरल और आसानी से समझ आने वाली संरचना देता है, इसलिए यह technical documentation लिखने में उपयोगी है

  • Logdy के documentation को Diátaxis के साथ लिखा जा रहा है, और इस तरीके के software product documentation के लिए उपयोगी होने पर राय मांगी गई। यह भी बताया गया कि blog post के ज़रिए product के उपयोग का तरीका प्रभावी रूप से समझाया गया