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

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

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

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

कोलिबरी

तकनीकी लेखक:

StephDix

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

कोलिब्री ईकोसिस्टम से जुड़े दस्तावेज़ की स्टाइल और वर्कफ़्लो के तरीके

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

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

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

खास जानकारी

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

खास जानकारी

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

मकसद और दायरा

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

दर्शक

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

मकसद

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

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

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

सॉफ़्टवेयर

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

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

परिणाम

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

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

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

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