इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- WordPress
- तकनीकी लेखक:
- टैसिटोनिक
- प्रोजेक्ट का नाम:
- दस्तावेज़ की स्टाइल गाइड का पूरा और रिन्यू किया गया सेट
- प्रोजेक्ट की अवधि:
- लंबे समय तक दौड़ना (पांच महीने)
प्रोजेक्ट का विवरण
रूपरेखा:
WordPress, एक ग्लोबल गैर-लाभकारी सॉफ़्टवेयर संगठन है. इसका मकसद, ऐसे सॉफ़्टवेयर की मदद से दुनिया भर के समुदायों की मदद करना है जो सुलभता, परफ़ॉर्मेंस, सुरक्षा, और इस्तेमाल में आसानी को बढ़ावा देते हैं. WordPress का मकसद, वेब पर पब्लिशिंग और ओपन सोर्स सॉफ़्टवेयर को लोगों के लिए उपलब्ध कराना है. हमारे डिजिटल दौर में, कोई वेबसाइट किसी संगठन/व्यक्ति का ऑनलाइन मुखौटा बन जाती है. साथ ही, WordPress, अपने सॉफ़्टवेयर की मदद से लाखों उपयोगकर्ताओं को इंटरनेट का 35% हिस्सा आसानी से उपलब्ध कराने का बड़ा काम करता है. इन उपयोगकर्ताओं को बेहतर सेवाएं देने के लिए, दस्तावेज़ ज़रूरी साबित होते हैं. ज़्यादातर डेवलपर, एडमिन, और असली उपयोगकर्ता इसका इस्तेमाल करते हैं. इसलिए, दस्तावेज़ को WordPress नेटवर्क के मुख्य फ़ैक्टर के तौर पर इस्तेमाल किया जा सकता है. मौजूदा WordPress दस्तावेज़ में, पब्लिश करने के लिए सभी नियमों और स्टाइल से जुड़े दिशा-निर्देशों और नियमों का एक यूनिफ़ाइड सेट शामिल नहीं है. इस प्रस्ताव का मकसद दस्तावेज़ स्टाइल से जुड़े दिशा-निर्देशों का एक पूरा और रिन्यू किया गया सेट बनाना है, जो सभी जगह WordPress के दस्तावेज़ों के लिए लागू हो सकता है. प्रोजेक्ट आइडिया में डिज़ाइन और स्टाइल के दिशा-निर्देशों से जुड़े सभी पहलुओं को शामिल करना शामिल है, जैसे कि सिमेंटिक, वाक्य, और व्याकरण के दिशा-निर्देश, विराम चिह्न, डेवलपमेंट से जुड़े नियम, डिज़ाइन के एट्रिब्यूट, और फ़ॉर्मैट से जुड़ी खास बातें. इसमें भाषा की परंपराओं का भी ध्यान रखा जाता है, जैसे कि आवाज़, टोन, काल, बोली के सभी हिस्सों के साथ-साथ नाम रखने के तरीके भी. WordPress सीएमएस, GitHub, और Markdown फ़ाइल टूल, भाषाओं, और प्लैटफ़ॉर्म का इस्तेमाल किया जाएगा. इनमें PHP/MySQL, HTML/CSS, और JavaScript भी शामिल हो सकते हैं.
प्रोजेक्ट प्लान:
WordPress की डॉक्यूमेंटेशन स्टाइल गाइड की मौजूदा स्थिति: WordPress दस्तावेज़ की टीम, पब्लिश करने के दिशा-निर्देशों के बारे में बिना जानकारी दिए, एक जैसा तरीका लागू कर रही है. हालांकि, कभी-कभी ऐसा होने पर कुछ चीज़ों को पहले से ही सोच लिया जाता है और फिर आगे की प्रक्रिया काल्पनिक बन जाती है. WordPress के लिए लेख लिखने और पब्लिश करने के लिए, कोई तय स्टैंडर्ड और शर्त मौजूद नहीं है. दस्तावेज़ों को मैनेज करने वाली टीम ने प्रोजेक्ट के हिसाब से, स्टाइल के लिए दिशा-निर्देश तैयार किए हैं, लेकिन इनमें से कोई भी दिशा-निर्देश दुनिया भर में लागू नहीं होते. स्टाइल से जुड़े ज़्यादातर दिशा-निर्देश, किसी एक हैंडबुक में शामिल नहीं होते या वे अब काम नहीं करते और उन्हें अपडेट करना ज़रूरी है. इसलिए, WordPress दस्तावेज़ के स्टैंडर्ड के मुताबिक, एक यूनिफ़ाइड स्टाइल गाइड को डिज़ाइन और डेवलप करने की ज़रूरत है.
मकसद:
इंटरनेट की 35% से ज़्यादा वेबसाइटें, WordPress पर चलती हैं. इससे पता चलता है कि लाखों डेवलपर और असली उपयोगकर्ता, WordPress की बेहतरीन सुविधाओं का इस्तेमाल कर रहे हैं. दस्तावेज़ की मदद से डेवलपर और उपयोगकर्ता, बिना किसी परेशानी के इन सुविधाओं को आसानी से पूरा कर सकते हैं. भले ही, उन्हें किसी तरह की परेशानी हो. इस प्रोजेक्ट प्रस्ताव का मकसद, डिज़ाइन और स्टाइल गाइड का स्टैंडर्ड तय करना, मौजूदा स्टाइल गाइड को एक जैसा करना, और अपडेट करना है. साथ ही, WordPress के दस्तावेज़ में नए नियम और खास जानकारी जोड़ना है. इससे WordPress के दस्तावेज़ों को आसानी से इस्तेमाल किया जा सकेगा, उन्हें आसानी से समझा जा सकेगा, और उन्हें एक जैसा बनाया जा सकेगा.
रणनीति लागू करने का तरीका:
इस प्रोजेक्ट के लिए, मेंटॉर (जॉन ऐंग) के सुझाव के मुताबिक, प्रोजेक्ट को चार चरणों में पूरा किया जा सकता है: डिस्कवरी, परिभाषा, लागू, और रखरखाव का चरण. प्रोजेक्ट शुरू करने से पहले, इंटर्नशिप से पहले, मैं अपने मेंटॉर के साथ काम करता हूं. साथ ही, तय शेड्यूल और समयावधि तय करता हूं. मैं इस प्रोजेक्ट के लिए WordPress सिस्टम और वर्क प्रोटोकॉल के बारे में जान लूंगा.
इंटर्नशिप शुरू होने पर, मैं अपने मेंटॉर के साथ इस प्लान के बारे में चर्चा करूंगा/करूंगी और ड्राफ़्ट बनाऊंगी. इसके लिए, ज़रूरी शर्तें और ज़रूरतें तय की जाएंगी. सबसे पहले, हम दस्तावेज़ के फ़्लो और उपयोगकर्ता के इंटरैक्शन की प्रोसेस के बारे में बताएंगे. इसके बाद, हर सेक्शन, कैटगरी, और कॉम्पोनेंट के लेआउट वायरफ़्रेम की आउटलाइन तैयार की जाएगी. इसके बाद, मेरे मेंटॉर इन लेआउट की समीक्षा करेंगे. ज़रूरत पड़ने पर, लेआउट को फिर से डिज़ाइन किया जाएगा और कुछ कॉम्पोनेंट जोड़े/हटाए जाएंगे. इसके बाद, मुझे इंटरफ़ेस फ़्लो की उपयोगिता और ज़रूरत के हिसाब से, उपयोगकर्ताओं के बारे में रिसर्च करनी होगी. इसके बाद, डॉक्यूमेंटेशन स्टाइल गाइड को हर सेक्शन के हिसाब से लागू किया जाएगा, जैसा कि नीचे दिए गए डायग्राम में दिखाया गया है. किसी भी ओपन सोर्स या क्रिएटिव कॉमंस लाइसेंस के तहत आने वाले दूसरे संगठनों की स्टाइल गाइड को भी हमारी गाइड में जोड़ा जा सकता है. अगर इस दौरान ऐप्लिकेशन को इस्तेमाल करने में कोई समस्या आती है, तो मैं उस पेज को फिर से डिज़ाइन कर दूंगा.
स्टाइल गाइड के पूरा होने और हेल्पHub के साथ इंटिग्रेट होने के बाद, टेस्ट और ऑप्टिमाइज़ेशन किए जाएंगे. किसी भी जोखिम की आशंका, ग़ैर-ज़रूरी एलिमेंट या कॉम्पोनेंट को ठीक कर दिया जाएगा. यूज़र इंटरफ़ेस (यूआई) और कोड की जांच की जाएगी. साथ ही, ज़रूरत पड़ने पर अनचाही गड़बड़ियों और गड़बड़ियों को ठीक किया जाएगा. भाषा, व्याकरण, वर्तनी, विराम चिह्न वगैरह के लिए, पूरी स्टाइल गाइड के लिए आखिरी क्वालिटी कंट्रोल का इस्तेमाल किया जाएगा.
अचानक हुई देरी की वजह से, बचे हुए टास्क, बफ़र पीरियड में पूरे हो जाएंगे. प्रोजेक्ट के दौरान, अन्य फ़ंक्शन या सुविधाओं को टेस्ट पूरा होने के बाद लागू किया जा सकता है. एक डिप्लॉयमेंट प्लान बनाया जाएगा और तैयार प्रॉडक्ट सबमिट किया जाएगा.
टूल और तरीके:
दस्तावेज़ को Google दस्तावेज़ जैसे किसी सहयोगी प्लैटफ़ॉर्म पर कंपाइल किया जाएगा और उसमें बदलाव किया जाएगा. अगर ज़रूरी हो, तो GitHub की मदद से कॉन्टेंट पब्लिश करने के लिए, Markdown या GitHub Flavored Markdown जैसी मार्कअप भाषाओं का इस्तेमाल किया जा सकता है. डिज़ाइन और स्टाइल से जुड़े स्टैंडर्ड के लिए, ओपन सोर्स स्टाइल के दिशा-निर्देशों का भी रेफ़रंस दिया जा सकता है. आखिर में, पूरे दस्तावेज़ को WordPress का इस्तेमाल करके फ़ॉर्मैट और पब्लिश किया जाएगा.
कॉम्पोनेंट टेबल:
यह उन कॉम्पोनेंट की पूरी सूची है जिन्हें स्टाइल गाइड में लागू किया जा सकता है. दस्तावेज़ के दिशा-निर्देश - सुलभता, दस्तावेज़ का स्ट्रक्चर, एन्कोडिंग, बाहरी सोर्स, तथ्य, फ़ॉन्ट, ग्लोबल ऑडियंस, सबको शामिल करने की क्षमता, वैधता, कई प्लैटफ़ॉर्म पर सुलभता, साफ़ तौर पर कोई जानकारी नहीं, बहुत ज़्यादा दावे नहीं करना, पेज का लेआउट, राजनैतिक सहीता, प्रोटोकॉल, सुरक्षा, वाक्य की बनावट, संक्षिप्त लेखन, टोन और स्टाइल, निष्पक्ष
भाषा और व्याकरण - संक्षिप्त नाम और संक्षिप्त रूप, सहमति और निगेशन, लेख, अक्षर बड़े करना, खंड, प्रत्यक्ष/अप्रत्यक्ष भाषण, पहला/दूसरा/तीसरा व्यक्ति, लिंग, शब्दावली, संज्ञा, उपसर्ग और प्रत्यय, पूर्वसर्ग, सर्वनाम, संदर्भ, स्लैंग और जार्गन, वॉइस, तकनीकी शब्द, Tense,
विराम चिह्न - अपॉस्ट्रफ़ी और कोटेशन मार्क, कोलन और सेमी कोलन, कॉमा, एलिप्स, विस्मयादिबोधक चिह्न, हाइफ़न और डैश, ब्रैकेट, विराम चिह्न, सवाल के निशान, स्लैश
फ़ॉर्मैटिंग - ऐब्सट्रैक्ट, ट्यूटोरियल, परिचय, प्रस्तावना, ब्रैंड के नाम, प्रॉडक्ट के नाम, कैप्शन, कोड स्निपेट, कोड ब्लॉक, तारीख और समय, समय क्षेत्र, जगह, मुद्राएं, फ़ाइल के नाम, फ़ुटनोट, टाइटल और टाइटल, हाइलाइटिंग (बोल्ड, इटैलिक, अंडरलाइन नंबर, स्ट्राइकथ्रू, कोट करने के लिए इस्तेमाल की जाने वाली चीज़ें, लिंक और यूआरएल, कॉपीराइट के कोटेशन, टेक्स्ट की सूचियां,
उपयोगकर्ता इंटरफ़ेस - गतिविधियां, बटन, कोड स्निपेट, कोड ब्लॉक, कमांड लाइन इंटरफ़ेस, डायलॉग, मेन्यू और ड्रॉपडाउन, पॉप-अप और अलर्ट, टैब, शब्दावली, यूज़र इंटरफ़ेस (यूआई) एलिमेंट, Windows
कोड - CSS, HTML, JS, Markdown, MySQL, PHP, सिंटैक्स, एक्सएमएल
शब्द उपयोग शब्दकोश/शब्दावली - A से Z