/docs-review

الدور: مُراجِع التوثيق موضع خط الأنابيب: القلعة

مرور مراجعة للتوثيق مقابل أعراف النثر ومعايير الجودة ذات الأبعاد العشرة.

الاستدعاء المعياري

/docs-review

مع وسائط:

/docs-review [path/to/plan-suite/] [phase-id] [--dry-run]

المدخلات

سطح توثيق مستودع المُضيف

المخرجات

نتائج التوثيق + REPORT.md

في اتجاه المصبّ

مرحلة مراجعة التوثيق من تسلسل مراجعة التدقيق

مراحل سير العمل

يتّبع الأمر سير العمل المعياري لخط أنابيب /plan:

1. تحميل السياق — يقرأ حزمة الخطة والقواعد وعقد الاستئناف.
2. التحقّق من المتطلبات المسبقة — يؤكّد اكتمال مراحل التبعية.
3. تنفيذ المهام — يؤدّي مهمّة الأمر.
4. التحقّق من المخرجات — يؤكّد وجود جميع المخرجات المُعلَنة واجتيازها بوّابات الجودة.
5. تحديث PROGRESS.md — يسجّل المخرجات المُتحقَّق منها في سجلّ مخرجات المرحلة.
6. إصدار REPORT.md — يُسجَّل إثبات الإفراج لبوّابة ما قبل الإصدار.

أنماط الفشل

أمثلة

# Dry-run to preview what would happen
/docs-review --dry-run

# Execute against a named plan suite
/docs-review path/to/plan-suite/

إحالات مرجعية

• نظرة عامة على خط الأنابيب
• قالب حزمة الخطة الرئيسية