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

इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.

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

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

Kolibri

टेक्निकल राइटर:

StephDix

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

Kolibri ईकोसिस्टम के दस्तावेज़ों का स्टाइल और वर्कफ़्लो

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

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

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

खास जानकारी

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

खास जानकारी

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

मकसद और दायरा

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

ऑडियंस

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

मकसद

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

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

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

सॉफ़्टवेयर

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

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

परिणाम

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

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

प्रोजेक्ट के हिसाब से टास्क

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