التأليف: كتابة المواضيع وتحريرها
قبل أن تكتب
- اقرأ قواعد الأسلوب و
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) تسرد مواضيعه، فأضف نقطة هناك.
- شغّل
python3 tools/localize.pyلاشتقاق الموضوع فيen-001وen-gbوen-us. - شغّل
just nav، ثمjust test.
تحرير موضوع قائم
- حافظ على ترتيب الأقسام والعناوين كما هي. تفحص الاختبارات أن مواضيع المحتوى لا تزال تضم كل قسم مطلوب.
- حافظ على التعريفات المضمّنة وروابط ويكيبيديا والجداول وقائمة المراجع ما لم يكن التحرير متعلقًا بها تحديدًا.
- لا تُدخل شرطات طويلة أو العبارات المحظورة. إذا كنت تعيد الصياغة فأعد كتابة الجملة بدلًا من حشر شرطة.
- شغّل
python3 tools/localize.pyبعد ذلك لإعادة اشتقاقen-001وen-gbوen-usمن مصدرen-gb-oxendictالمحرَّر.
إعادة التسمية أو إعادة الترقيم
- أعد تسمية الملف في
locales/en-gb-oxendict/، وحدّث عنوانه# N.M Title، وحدّثspec/structure.md، وحدّث كل إحالة تشير إلى الرقم القديم. - شغّل
python3 tools/localize.pyلإعادة تسمية الملف في المحليات الثلاث الأخرى أيضًا (فهو يشتق الأربع كلها من المسارات النسبية نفسها). - شغّل
just navوjust test. ستنبّه الاختبارات إلى عدم تطابق العنوان H1 مع اسم الملف، أو فجوة في الترقيم، أو محلية انحرفت عن المصدر، أو رابط معطوب.
تذكير بالنبرة
اكتب كما يكتب زميل ذو خبرة يريد للقارئ أن ينجح. دافئ وبسيط ومباشر ومفيد. جمل قصيرة. بلا حشو.