إنتقل إلى المحتوى الرئيسي

دليل أسلوب المحتوى

جميع المستويات

الاتساق هو ما يجعل المرجع يبدو جديرًا بالثقة. اتبع هذه الإرشادات وسيمرّ طلب السحب الخاص بك بسلاسة عبر المراجعة.

النبرة​

  • واضحة ومباشرة. جُمل قصيرة. ابدأ بالفكرة.
  • ودودة، لا حشو فيها. احذف عبارات مثل "في عالم اليوم سريع الإيقاع." احترم وقت القارئ.
  • صاحبة رأي، ثم أمينة. قدّم الطريقة الواحدة المُوصى بها أولًا، ثم أشِر إلى البدائل والمفاضلات.
  • الأمثلة قبل النظرية. أرِ مقتطفًا أو حالة ملموسة؛ لا تكتفِ بالوصف.
  • الإنجليزية الأمريكية.

بنية الصفحة​

---
sidebar_position: 2
title: "Your Page Title"
description: "One sentence for search and previews."
---

<LevelBadge level="beginner" />

A one or two sentence intro that states what the reader will get.

## Sections with ## headings
...

## Next
- 2–4 links to related pages
  • ابدأ بشارة المستوى (beginner | intermediate | advanced | all). المكوّنات عامة — لا تستوردها.
  • اختم بقائمة "التالي" / "ذات صلة" من 2–4 روابط داخلية.
  • استخدم التنبيهات (:::tip، :::warning، :::note، :::info) للتأكيد، باعتدال.

القاعدتان الصارمتان​

:::warning غير قابلتين للتفاوض

  1. استشهد بالمصادر للحقائق المتقلّبة. أسماء النماذج، والأسعار، والحدود، والأعلام الدقيقة، والميزات التجريبية ← اربط المصدر الرسمي وأضف <VerifyNote lastVerified="YYYY-MM-DD" source="…">. لا تُضمِّن حقائق النماذج كقيم ثابتة أبدًا — اربط بـجدول النماذج. التفاصيل: التحقق من الحقائق.
  2. لا تختلق. لا إحصاءات أو اقتباسات أو واجهات برمجية (APIs) أو ميزات مخترَعة. إن لم تكن متأكدًا، قل ذلك أو ضع علامة [verify]. :::

الرأي مقابل الرسمي​

  • نحن أصحاب رأي — وهذه هي القيمة. أوصِ، لا تكتفِ بالتعداد.
  • لكن الوثائق الرسمية هي مصدر الحقيقة. خَلِّ لها الأولوية، واربط بها، ولا تناقضها بصمت أبدًا.

مزالق MDX​

  • الأقواس المعقوفة {like this} في النص يُفسّرها MDX على أنها كود — ضعها في علامات اقتباس خلفية (backticks) أو في كتل كود، أو استخدم [brackets] في الأمثلة.
  • اختبر محليًا: يجب أن يمرّ npm run build (فهو يفشل عند الروابط المعطّلة).

التالي​