عن هذه الأدلة

OktoID منصة هوية رقمية ذاتية السيادة على المستوى الوطني. تشرح هذه الأدلة كيفية استخدامها. لكل فئة من القرّاء دليل خاص بها، لأن كل فئة تأتي بسؤال مختلف، والدليل الذي يحاول الإجابة عن أسئلة الجميع لا يجيب عن أيٍّ منها إجابةً وافية.

لمن كُتب كل دليل

الدليل	لمن	السؤال الذي يجيب عنه
دليل المشغّل	مُشغّل المنصة	كيف أشغّل المنصة، وماذا أفعل عند حدوث عطل
دليل الحوكمة	موظفو جهة الحوكمة	كيف أقبل انضمام مؤسسة، وأضع سياسة، وأسحب الثقة
دليل مدير النظام	موظفو الجهات المُصدِرة والجهات المُتحقِّقة	كيف أصمّم بيانات ثبوتية، وأُصدرها، وأتحقق منها
دليل التكامل	المهندسون الذين يربطون أنظمتهم بالمنصة	كيف أستدعي OktoID من نظامي
مساعدة حاملي البيانات الثبوتية	المواطنون، وموظفو الدعم الذين يجيبون عن أسئلتهم	أين بياناتي الثبوتية، وهل هذه الرسالة حقيقية
دليل المهندسين	المهندسون الذين يصونون المنصة ويطوّرونها	كيف بُنيت المنصة، وكيف أوسّعها

يُنشر كل دليل مع القدرة التي يصفها. فإن لم تجد دليلًا هنا، فهو يصف شيئًا لم يُسلَّم بعد.

كيف رُتّبت الوثائق

في الشريط العلوي مدخل لكل فئة من القرّاء، ومرجع تشترك فيه الفئات كلها.

المدخل	لمن	ما يضمّه
التكامل	المهندسون الذين يربطون أنظمتهم بالمنصة	دليل التكامل
حزم SDK	المطوّرون الذين يبنون باستخدام مكتبات OktoID، والمهندسون الذين يصونون المنصة	دليل المهندسين
التشغيل	مُشغّل المنصة	دليل المشغّل
الحوكمة	موظفو جهة الحوكمة، ومسؤولو المؤسسات	دليل الحوكمة ودليل مدير النظام
المرجع	الجميع	واجهة HTTP API، بصفحة لكل عملية، والحزم البرمجية المشتركة

كل صفحة داخل المدخل من نوع واحد من ثلاثة أنواع:

• الدرس التطبيقي يأخذك في مسار واحد من بدايته إلى نهايته. ابدأ بدرس منها إن كنت جديدًا على OktoID؛
• دليل الاستخدام يحلّ مهمة واحدة، لقارئ يعرف المنصة؛
• صفحة المفهوم تشرح لماذا صُمّم الشيء على ما هو عليه.

يبيّن المرجع ماهية كل عملية وكل حزمة برمجية، على نحو شامل، ولا شيء غير ذلك. ويُولَّد من الشيفرة المصدرية للمنصة بدلًا من أن يُكتب يدويًا.

أيّ إصدار تقرأ

تنتمي كل صفحة إلى إصدار من إصدارات المنصة، ويُظهر مُحدِّد الإصدار في أعلى الصفحة الإصدار الذي تقرؤه. اختر الإصدار الذي تعمل به منصتك، فقد تصف صفحة من إصدار آخر شاشاتٍ أو إعداداتٍ أو خطواتٍ تختلف عمّا أمامك.

الإصدار المعنون قيد التطوير يصف عملًا لم يُضمَّن في أي إصدار بعد.

اللغات والبحث

الأدلة متاحة بالعربية والإنجليزية. للتنقل بينهما استخدم مُحدِّد اللغة في أعلى الصفحة، وتُقرأ النسخة العربية من اليمين إلى اليسار.

يعمل البحث دون اتصال بالإنترنت، لأن فهرس البحث جزء من الموقع نفسه، ويبحث في اللغة التي تقرأ بها.

الحصول على نسخة PDF

يمكن طباعة كل دليل في ملف PDF مرقّم الصفحات، من المصدر نفسه الذي بُنيت منه هذه الصفحات، لاستخدامه في ملفات وثائق القبول والنسخ المطبوعة. ويُنتَج ملف PDF واحد لكل لغة. إذا كانت لديك نسخة من المستودع، فبعد بناء الموقع نفّذ:

pnpm --filter @oktoid/docs-site pdf

وإلا، فاطلب من الفريق المسؤول عن منصتك ملف PDF الخاص بالإصدار الذي تعمل به.