कोलिब्री प्रोजेक्ट

इस पेज में, Docs के Google सीज़न के लिए स्वीकार किए गए तकनीकी राइटिंग प्रोजेक्ट की जानकारी दी गई है.

प्रोजेक्ट की खास जानकारी

ओपन सोर्स संगठन:

कोलिब्रि

तकनीकी लेखक:

StephDix

प्रोजेक्ट का नाम:

कोलिब्रि ईकोसिस्टम से जुड़े डॉक्यूमेंटेशन स्टाइल और वर्कफ़्लो के तौर-तरीके

प्रोजेक्ट की अवधि:

लंबे समय तक दौड़ना (पांच महीने)

प्रोजेक्ट का विवरण

खास जानकारी

इस दस्तावेज़ में, कोलिब्री ईकोसिस्टम प्रोजेक्ट के लिए, लर्निंग इक्वलिटी की दर्ज की गई जानकारी के लिए, स्टाइल से जुड़े दिशा-निर्देश लागू करने और वर्कफ़्लो मैनेजमेंट की जानकारी दी गई है.

खास जानकारी

मेरे प्रस्ताव में चार चरण हैं. पहले चरण में, मैं सॉफ़्टवेयर डेवलपमेंट में एलई के कॉन्सेप्ट और स्टाइल से जुड़े दिशा-निर्देशों के मुताबिक, सुलभता के दिशा-निर्देशों, लिखने, और फ़ॉर्मैट के सुझाव देने के साथ-साथ LE डॉक्यूमेंटेशन स्टाइल गाइड को पूरा करूंगा/करूंगी. दूसरे चरण में, मैं ReadTheDocs और GoogleDocs दस्तावेज़ों की क्वालिटी की जाँच करूंगी. ऑडिट प्लान में चेकलिस्ट की मदद से, स्टाइल से जुड़े दिशा-निर्देशों के पालन का आकलन किया जाता है. ये चेकलिस्ट, नतीजों को रिकॉर्ड करने और दस्तावेज़ों में बदलाव लागू करने में मदद करेंगी. तीसरे चरण में, मैं ReadTheDocs और GoogleDocs दस्तावेज़ों के टेंप्लेट के स्ट्रक्चर, लुक, और स्टाइल पर काम करूंगा. मैं Google Drive में टेंप्लेट और इमेज रिपॉज़िटरी (डेटा स्टोर करने की जगह) बनाऊंगा/बनाऊंगी, ताकि आने वाले समय में लागू किए जाने वाले तरीकों में फिर से इस्तेमाल करने के लिए, मुख्य दस्तावेज़ के टाइप की हर टेंप्लेट कैटगरी की पहचान की जा सके. मुझे पुल के अनुरोध की समीक्षाओं में आसानी से पहचान करने के लिए, टेंप्लेट से जुड़ी समस्याएं सबमिट करने के लिए, टेंप्लेट बनाने के इस टास्क को पूरा करना है. आखिर में, मैं योगदान देने वालों के लिए एक गाइड तैयार करूंगा/करूंगी, जिसमें सहयोगियों के हर ग्रुप के लिए, काम के संसाधनों का ग्रुप बनाया जाएगा. इससे, जानकारी ऐक्सेस करने के उनके अनुभव को बेहतर बनाया जा सकेगा.

मकसद और दायरा

इस योजना को लागू करने का मकसद, कोलिब्री के दस्तावेज़ों का इस्तेमाल करने वाले असली उपयोगकर्ताओं के अनुभव को बेहतर बनाना है. साथ ही, टीम के सदस्यों और योगदान देने वालों की मदद करना है, ताकि वे बेहतर दस्तावेज़ बना सकें और समुदाय में साथ मिलकर काम कर सकें. यह बदलाव, कोलिब्री ईकोसिस्टम में ReadTheDocs और Google Docs के दस्तावेज़ों के सब-सेट पर लागू होता है.

दर्शक

लागू करने वाले लोगों, एडमिन, और असली उपयोगकर्ताओं की मुख्य ऑडियंस, जो कोलिब्री के दस्तावेज़ के सबसे अहम उपभोक्ता हैं. कोलिब्री के दस्तावेज़ बनाने और इस्तेमाल करने के लिए, टीम के सदस्यों और सहयोगियों का एक और दर्शक.

मकसद

कोलिब्री ईकोसिस्टम दस्तावेज़ के लिए स्टाइल गाइड और वर्कफ़्लो सिस्टम की मदद से, लोगों से ये उम्मीद की जाती है: आसानी से समझने लायक दस्तावेज़, भाषा से ऐक्सेस करने लायक और एक जैसे लेआउट वाले दस्तावेज़ बनाएं. दस्तावेज़ के ज़रिए अच्छी क्वालिटी के तरीकों का रखरखाव करें. दस्तावेज़ चैनलों के बीच जानकारी तक आसानी से पहुंचना. कोलिब्री के ओपन-सोर्स समुदाय में, साथ मिलकर काम करने की पहल को बेहतर बनाना.

जानकारी के स्रोत

Google Drive से मेरे डेटा सोर्स कोलिब्री, कोलिब्री स्टूडियो, Kolibri डेवलपमेंट से जुड़े आरटीडी दस्तावेज़, और Kolibri टूलकिट जैसी जानकारी मिली थी.
असाधारण गतिविधियां और प्रोजेक्ट से जुड़ी खास गतिविधियों में मदद करने में Radia Matic ने बड़ी मदद की है. संगठन में ""दिशा-निर्देश"" और ""गाइड"" के तौर पर उनकी राय और योगदान देने वालों के लिए गाइड की मौजूदगी के बारे में दी गई जानकारी से, मुझे अपने विचारों को व्यवस्थित करने और नतीजों को ड्राफ़्ट करने में मदद मिली.

सॉफ़्टवेयर

मैं Google Docs में स्टाइल गाइड का ड्राफ़्ट बनाऊंगा/बनाऊंगी. जब यह पब्लिश होने के लिए तैयार होता है, तब दस्तावेज़ का यह प्लैटफ़ॉर्म फिर से इस्तेमाल करने के लिए सही है. QA ऑडिट के लिए, मैं दस्तावेज़ों को आयोजित करने और उनका मूल्यांकन करने के लिए Google Forms का इस्तेमाल करूंगा/करूंगी. एक स्प्रेडशीट, दस्तावेज़ कंट्रोल करने के लिए फ़ॉर्म के जवाबों को स्टोर करेगी. मैं GitHub का इस्तेमाल करके, आरटीडी दस्तावेज़ों की रीफ़ैक्टरिंग में हूं. मैंने Git, Gitdraken, GitHub, और Gitlab के साथ काम किया है. मुझे Markdown और कुछ Reस्ट्रक्चर्डText के बारे में जानकारी है. सिंटैक्स सीखने के लिए, मैं दस्तावेज़ से जुड़े सुधार करने के बारे में सोच रहा/रही हूं. मैं इमेज और GIF के लिए Sharex का इस्तेमाल करूंगा/करूंगी. मुझे यह टूल बहुत पसंद है, क्योंकि यह अलग-अलग आउटपुट फ़ॉर्मैट में रेंडर होता है. मैं डायग्राम बनाने के लिए डायग्राम और इमेज वाले वर्शन का इस्तेमाल करूंगा/करूंगी. डायग्राम सॉफ़्टवेयर, GoogleDocs, Google Drive, और LibreOffice के साथ बहुत अच्छे से काम करता है. दस्तावेज़ की स्थिति एक्सप्लोरेशन के दौरान, मैंने कोलिब्री के ज़्यादातर दस्तावेज़ों में बदलाव किए हैं. मुझे प्रोजेक्ट के ज़्यादातर दस्तावेज़ों में व्याकरण की गलतियां, टाइपिंग की गलतियां, लेआउट, टाइपोग्राफ़ी, इमेज का इस्तेमाल, और दस्तावेज़ों में मौजूद गड़बड़ी वाले पाथ मिले हैं. उदाहरण के लिए, Kolibri की उपयोगकर्ता गाइड में, समस्या हल करने वाला सेक्शन एक उप-विषय है, न कि कोई विषय. यह जानकारी इतनी अहम होती है कि असली उपयोगकर्ताओं को विषय सूची से इस जानकारी का ऐक्सेस मिल सके. दूसरे विकल्प के तौर पर, वे अन्य विषयों को बड़ा करने और समस्या हल करने वाले लेखों का पता लगाने के लिए, खोज बार और विषय सूची ट्री का इस्तेमाल कर सकते हैं.

“समस्या का हल” सेक्शन को ऐक्सेस करने के लिए, आपको या तो इसे खोजना होगा या “Manage Kolibri” को बड़ा करना होगा. इससे, आपको पता चलेगा कि समस्या हल करना दस्तावेज़ के तौर पर मौजूद है. गाइड बनाम दिशा-निर्देश इस प्रोजेक्ट के प्रस्ताव के लिए, मैंने दो दस्तावेज़ों का विश्लेषण किया है: LE Kolibri की यूज़र डॉक्यूमेंटेशन स्टाइल गाइड और LE अनुवाद के दिशा-निर्देश. एलई कोलिब्री की गाइड में, मैंने अपने सुझाए गए विषय की आउटलाइन और दस्तावेज़ प्लान से सुझाव और टिप्पणियां दी हैं. साथ ही, ऐसी कुछ अन्य चीज़ों को भी गाइड किया है जिनमें सुधार की ज़रूरत है. एलई के अनुवाद के दिशा-निर्देशों के लिए, मैंने अपने सुझावों और स्टाइल गाइड के मौजूदा तौर-तरीकों के आधार पर फ़ॉर्मैट और स्टाइल में बदलाव किया है. विश्लेषण के दौरान, मेरा ध्यान सबसे ज़्यादा उस गलत धारणा पर आया जो गाइड और दिशा-निर्देशों की कैटगरी वाले दस्तावेज़ों के बीच मौजूद है.

परिणाम

मैंने एक शुरुआती फ़ॉर्म के साथ सुझावों और टिप्पणियों के साथ-साथ LE Translation गाइड की क्वालिटी की जांच की है, जिसके बारे में मैंने QA ऑडिट टास्क में ज़्यादा विस्तार से बताया है. आकलन से मिली कुछ आखिरी टिप्पणियां हैं: ICU सिंटैक्स .js वेबसाइट के टूटे लिंक इन दिशा-निर्देशों को बनाने के लिए इस्तेमाल किया गया फ़ॉर्मैट गलत है. यह दस्तावेज़ एक गाइड है, न कि दिशा-निर्देश. अलग-अलग टाइपोग्राफ़ी. हेडिंग और टाइटल का गलत इस्तेमाल, भाषा का गलत इस्तेमाल, और संक्षेपों का गलत इस्तेमाल. वैकल्पिक टेक्स्ट का गलत इस्तेमाल. बार-बार दिए गए स्टेटमेंट/ निर्देशों पर.

दोनों दस्तावेज़ों के नतीजे, इस प्रस्ताव के लिए डिलीवर किए जाने वाले कॉन्टेंट का हिस्सा हैं.

प्रोजेक्ट के टास्क

• LE User डॉक्यूमेंटेशन स्टाइल गाइड के सुझाव (टिप्पणियां)
• नई स्टाइल और फ़ॉर्मैट के साथ LE अनुवाद के दिशा-निर्देश.
• विषय की आउटलाइन
• प्रोजेक्ट की टाइमलाइन
• दस्तावेज़ से जुड़े टास्क