قواعد الأسلوب (مشتركة، قابلة للفرض)
أسلوب الكتاب في مكان واحد. البنود الموسومة “(test)” يفرضها tests/validate.py؛
وأي مخالفة تُفشل البناء. النسخة السردية الكاملة هي spec/conventions.md في جذر
المستودع.
القواعد الصارمة
- لا شرطات طويلة. لا تستخدم ”—” (U+2014) أبدًا. استخدم فاصلة أو نقطتين
رأسيتين أو أقواسًا أو جملتين. الشرطات المتوسطة ”–” مسموحة فقط في النطاقات
العددية مثل
1–9أو2.1–2.8. (test) - لا عبارات جاهزة. لا تستخدم “not only … but also” ولا “but also” ولا “load-bearing”. وتجنّب “It’s important to note” و”In today’s fast-paced world” و”It’s crucial to consider” و”It appears that” و”One could argue”، وصيغة “it’s not just X, it’s Y”. (test، للثلاث الأولى)
- عرّف المصطلحات عند أول استخدام. وسّع المختصرات وعرّف المصطلحات التقنية في أول مرة يستخدمها كل موضوع، مثل “mean time to recovery (MTTR).”
- اربط المفاهيم الأساسية بويكيبيديا عند أول ذكر، مرة واحدة لكل موضوع، في
النثر فقط. الصيغة:
[term](https://en.wikipedia.org/wiki/Article_Title). وليس في العناوين ولا الجداول ولا الكود ولا قسم المراجع. (شكل الرابط يُختبر) - مراجع حقيقية فقط. مؤلف وعنوان لأعمال حقيقية. لا عناوين ولا مؤلفين ولا روابط مختلقة.
- سمِّ مسار التلاعب. يذكر موضوع عائلة المقاييس كيف يُتلاعب بالمقياس وأي حاجز حماية يلتقط ذلك (الموضوع 1.2).
النبرة
- دافئة ومباشرة ومشجعة. خاطب القارئ بصيغة المخاطَب. جمل قصيرة وكلمات بسيطة. ابدأ بالنقطة.
- ذات رأي وعملية. محايدة تجاه البائعين. اذكر المنتجات أمثلةً واقعية فقط.
البنية (test)
- تستخدم مواضيع المحتوى ترتيب الأقسام الدقيق في
chapter-template.md. - العنوان الأول هو
# N.M Title(رقم الموضوع العشري)، ويطابق البادئةPP-CCالمرقّمة بأصفار في اسم الملف. - الترقيم داخل كل جزء متصل ويبدأ من N.0.
بعد التحرير
- إذا غيّرت مجموعة المواضيع، فحدّث
spec/structure.mdوشغّلjust nav. - شغّل
just testدائمًا.