लेखन: विषय लिखना और संपादित करना

लिखने से पहले

शैली नियम और रिपॉज़िटरी की जड़ में spec/conventions.md पढ़ें।
रिपॉज़िटरी की जड़ में spec/structure.md देखें कि विषय कहाँ बैठता है और उसे कौन सा क्रमांक मिलना चाहिए।

नया विषय लिखना

भाग और उस भाग में अगला खाली दशमलव क्रमांक चुनें। क्रमांकन सतत है, इसलिए नया विषय आमतौर पर अपने भाग के अंतिम विषय के बाद का क्रमांक लेता है।
विषय टेम्पलेट से locales/en-gb-oxendict/topics/PP-CC-slug.md बनाएँ (शून्य-भरा, डैश-विभाजित उपसर्ग, उदाहरण के लिए 02-01-...)। इसे ऑक्सफ़ोर्ड वर्तनी में लिखें (देखें spec/oxford-spelling.md); अन्य तीन लोकेल को कभी सीधे संपादित न करें।
टेम्पलेट के अनुसार लिखें। हर सामग्री विषय को अपने सभी अनुभाग चाहिए: अवलोकन, मुख्य सिद्धांत, सिफ़ारिशें, ट्रेड-ऑफ़ (एक तालिका सहित), चर्चा के प्रश्न, क्षेत्र दृष्टिकोण (स्टार्टअप, छोटा व्यवसाय, उद्यम, सरकार), उदाहरण (एक उद्यम और एक सरकारी), व्यावसायिक औचित्य, एंटी-पैटर्न, पाँच-स्तरीय परिपक्वता मॉडल, चर्चा के विचार, मुख्य निष्कर्ष और संदर्भ।
हेरफेर का रास्ता बताएँ। हर मेट्रिक परिवार को “टीम इस संख्या को कैसे अच्छा दिखाती है बिना उसे सुधारे जो यह मापती है, और कौन सा गार्डरेल इसे पकड़ता है” का स्पष्ट उत्तर चाहिए (देखें विषय 1.2)।
शब्दों को पहले उपयोग पर परिभाषित करें। मुख्य अवधारणाओं के लिए पहले उल्लेख पर विकिपीडिया लिंक जोड़ें, केवल गद्य में।
संबंधित विषयों को दशमलव से क्रॉस-रेफ़र करें, जैसे “(विषय 2.1)।”
विषय को spec/structure.md में जोड़ें।
यदि भाग का परिचय (N.0) अपने विषय सूचीबद्ध करता है, तो वहाँ एक बुलेट जोड़ें।
विषय को en-001, en-gb और en-us में व्युत्पन्न करने के लिए python3 tools/localize.py चलाएँ।
just nav चलाएँ, फिर just test।

मौजूदा विषय संपादित करना

अनुभाग क्रम और शीर्षक जस के तस रखें। परीक्षण जाँचते हैं कि सामग्री विषयों में अब भी हर आवश्यक अनुभाग है।
संपादन विशेष रूप से इनके बारे में न हो तो इनलाइन परिभाषाएँ, विकिपीडिया लिंक, तालिकाएँ और संदर्भ सूची सुरक्षित रखें।
एम-डैश या प्रतिबंधित वाक्यांश न लाएँ। यदि आप दोबारा लिख रहे हैं, तो डैश डालने के बजाय वाक्य नए सिरे से लिखें।
संपादित en-gb-oxendict स्रोत से en-001, en-gb और en-us को फिर से व्युत्पन्न करने के लिए बाद में python3 tools/localize.py चलाएँ।

नाम बदलना या पुनः क्रमांकन

locales/en-gb-oxendict/ में फ़ाइल का नाम बदलें, उसका # N.M Title शीर्षक अपडेट करें, spec/structure.md अपडेट करें, और पुराने क्रमांक की ओर इशारा करने वाला हर क्रॉस-रेफ़रेंस अपडेट करें।
अन्य तीन लोकेल में भी फ़ाइल का नाम बदलने के लिए python3 tools/localize.py चलाएँ (यह चारों को उन्हीं सापेक्ष पथों से व्युत्पन्न करता है)।
just nav और just test चलाएँ। परीक्षण H1 और फ़ाइल नाम में असंगति, क्रमांकन में अंतर, स्रोत से भटका लोकेल, या टूटा लिंक चिह्नित करेंगे।

लहजे की याद

ऐसे अनुभवी सहकर्मी की तरह लिखें जो चाहता है कि पाठक सफल हो। गर्मजोशी भरा, सरल, सीधा और उपयोगी। छोटे वाक्य। कोई भराव नहीं।