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