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