इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- TheGoodDocsProject
- टेक्निकल राइटर:
- Loquacity
- प्रोजेक्ट का नाम:
- जानकारी के आर्किटेक्चर की गाइड
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
जानकारी के आर्किटेक्चर के लिए गाइड प्लान
इस दस्तावेज़ में, Good Docs प्रोजेक्ट के लिए इन्फ़ॉर्मेशन आर्किटेक्चर गाइड की प्लानिंग के बारे में बताया गया है. इसे Google Season of Docs 2020 के सबमिशन के तौर पर तैयार किया गया था. इसमें, सुझाई गई गाइड के इस्तेमाल के उदाहरण के बारे में बताया गया है. साथ ही, प्लानिंग के मकसद से, इस तरह की गाइड के स्ट्रक्चर का प्लान भी बताया गया है.
इन्फ़ॉर्मेशन आर्किटेक्चर (आईए) से पता चलता है कि कॉन्टेंट को कैसे व्यवस्थित किया गया है. इसमें कॉन्टेंट के स्ट्रक्चर के बारे में बताया जाता है, न कि कॉन्टेंट में इस्तेमाल की गई शैली या शब्दों के बारे में. उदाहरण के लिए, आईए प्लान में इस बात का ध्यान रखा जाता है कि पाठक कौन है, वे कॉन्टेंट तक कैसे पहुंचते हैं, और किस माहौल में कॉन्टेंट पढ़ रहे हैं. इसके बाद, यह कॉन्टेंट के लिए सही स्ट्रक्चर तय करेगा, ताकि पाठकों की ज़रूरतों को बेहतर तरीके से पूरा किया जा सके.
आम तौर पर, दस्तावेज़ को कॉन्टेंट की रणनीति से शुरू करके डिज़ाइन किया जाता है. इस रणनीति में, दस्तावेज़ के लक्ष्यों को तय करने के लिए कारोबार के लक्ष्यों का इस्तेमाल किया जाता है. इसके बाद, कॉन्टेंट की रणनीति का इस्तेमाल करके आईए बनाया जाता है. इससे दस्तावेज़ का लेआउट और स्ट्रक्चर तय होता है. वहां से, टूलचेन चुनी जा सकती है और कॉन्टेंट तैयार किया जा सकता है. ज़्यादातर ओपन सोर्स प्रोजेक्ट के लिए, कॉन्टेंट की रणनीति बहुत आसान होती है. जैसे, "कुछ दस्तावेज़ लिखें, ताकि लोगों को इस प्रोजेक्ट को इस्तेमाल करने का तरीका पता चल सके". हालांकि, इस आसान रणनीति से भी असरदार आईए तय किया जा सकता है.
इस गाइड का मकसद पेशेवर लेखकों को एक आसान टूल देना है, ताकि वे एक ऐसा 'आईए' बना सकें जो यह तय करने के लिए काफ़ी हो कि उन्हें किन टेंप्लेट का इस्तेमाल करना चाहिए. यह इतना आसान होना चाहिए कि इसे कोई आम इंसान, दोपहर में पूरा कर सके. साथ ही, इसमें शिक्षा के बजाय, सिर्फ़ कुछ करने की कोशिश की जानी चाहिए. आम तौर पर, इस कॉन्टेंट में कॉन्सेप्ट को कम शब्दों में जानकारी दी जाती है और इन सिद्धांतों को अपने प्रोजेक्ट से जोड़ने के लिए लोगों को गाइड किया जाता है. इसके अलावा, इन कॉन्सेप्ट से मिले नतीजों का इस्तेमाल अगले कॉन्सेप्ट पर जाने के लिए किया जाता है.
इस प्रोजेक्ट के लिए, प्रोजेक्ट के रीडमी में कुछ अपडेट ज़रूरी हैं, ताकि पाठकों को Good Docs प्रोजेक्ट शुरू करने का तरीका समझ आ सके. साथ ही, वे टेंप्लेट चुनने के लिए, आईए गाइड का असरदार तरीके से इस्तेमाल कर सकें.
प्राइमरी ऑडियंस
वे सभी लोग जो अपने प्रोजेक्ट के लिए दस्तावेज़ बनाने के लिए, The Good Docs Project के टेंप्लेट का इस्तेमाल करना चाहते हैं
इस्तेमाल के उदाहरण: इस सेक्शन को इस तरह से डिज़ाइन किया गया है कि यह पता चल सके कि पाठक, आईए गाइड को कैसे इस्तेमाल करते हैं. इससे हमें यह पता चल सकता है कि उन पाठकों को बेहतर तरीके से जानकारी देने के लिए, गाइड को किस तरह से तैयार किया जाना चाहिए.
स्थिति:
कोई व्यक्ति किसी ऐसे ओपन सोर्स प्रोजेक्ट पर काम कर रहा है जिसमें बहुत कम या कोई दस्तावेज़ नहीं है या कोई ऐसा दस्तावेज़ सुइट है जो गलत तरीके से व्यवस्थित या लिखा गया है. उन्होंने अपने दस्तावेज़ व्यवस्थित करने के लिए, द गुड दस्तावेज़ प्रोजेक्ट का इस्तेमाल करने का फ़ैसला किया, लेकिन उन्हें नहीं पता कि शुरुआत कहां से की जाए. वे टेंप्लेट का इस्तेमाल शुरू करने का तरीका जानने के लिए, 'जानकारी' सेक्शन को पढ़ते हैं. साथ ही, कॉन्टेंट की रणनीति बनाने और दस्तावेज़ों के सुइट को तैयार करने का प्लान बनाने के लिए, Information Architecture Guide का इस्तेमाल करते हैं.
प्रपोज़ल
प्रोजेक्ट के बारे में नए पाठक को साफ़ तौर पर बताने के लिए, README को अपडेट करें. इसमें प्रोजेक्ट के शुरुआती चरणों के बारे में भी साफ़ तौर पर बताएं. इनमें से पहला कदम, नई आईए गाइड में दिए गए सवालों को पढ़ना और उनका जवाब देना होगा. इस गाइड में, पाठक को ऑडियंस, कॉन्टेंट स्कीमा, उपयोगकर्ता/टास्क मैट्रिक वगैरह के बारे में बताया जाएगा. हालांकि, इसमें पाठक पर यह ज़िम्मेदारी नहीं डाली जाएगी कि वह इन चीज़ों को अकादमिक तौर पर जाने/समझे. इस टास्क को पूरा करने के बाद, पाठक को यह समझ आ जाती है कि कौनसे टेंप्लेट ज़रूरी हैं और उन्हें बेहतर तरीके से कैसे पूरा किया जा सकता है.
रिसर्च
रिसर्च के आधार पर, मैं ऐबी कवर की किताब (http://www.howtomakesenseofanymes.com/) की किताब (http://www.howtomakesenseofanymes.com/) को पढ़ना पसंद करती हूं. इसकी एक वजह यह भी है कि मुझे इसके बारे में अच्छी तरह से जानकारी है और इसी कॉन्टेंट के आधार पर मैंने पहले ही कॉन्टेंट तैयार किया है. इसका इस्तेमाल भी किया जाएगा. हालांकि, नए लोगों के लिए 'आईए' में दिलचस्पी लेना बहुत आसान है. इस लिहाज़ से, यह एआई के लिए एक तरह की गेटवे ड्रग है.
ड्राफ़्ट किया गया कॉन्टेंट का क्रम
यह पढ़ें:
-- 'अच्छे दस्तावेज़' प्रोजेक्ट के बारे में जानकारी |_ टेंप्लेट का इस्तेमाल कौन कर सकता है |_ टेंप्लेट कैसे काम करते हैं |_ प्रोजेक्ट में योगदान देना -- टेंप्लेट के बारे में जानकारी |_ सभी मौजूदा टेंप्लेट की सूची |_ यह चुनना कि किन टेंप्लेट का इस्तेमाल करना है |_ शुरू करने से पहले जानकारी -- लिखना शुरू करने से पहले जानकारी |_ दस्तावेज़ कौन पढ़ता है? |_ वे दस्तावेज़ क्यों पढ़ते हैं? |_ अपने पाठकों के लिए लिखना
आईए गाइड:
-- परिचय |_ आईए क्या है? |_ मुझे क्यों चिंता करनी चाहिए? -- समस्या की पहचान करना -- अपनी मंशा बताना -- असल स्थिति का पता लगाना -- कोई दिशा चुनना -- दूरी का आकलन करना -- स्ट्रक्चर में बदलाव करना -- बदलाव के लिए तैयार होना