Skip to content
Apothem
पाइपलाइन कमांड

/docs-review

/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 उत्सर्जित करें — पूर्व-उत्सर्जन गेट का रिलीज़ प्रमाण दर्ज किया जाता है।

विफलता मोड

लक्षणकारणपुनर्प्राप्ति
पूर्वापेक्षा अपूर्णनिर्भर फ़ेज़ समाप्त नहीं हुआपहले अपस्ट्रीम फ़ेज़ पूरा करें
गुणवत्ता गेट FAILआउटपुट मानकों पर खरा नहीं उतरताआउटपुट ठीक करें और पुनः चलाएँ
इनपुट फ़ाइल अनुपस्थितप्लान सूट फ़ाइल नदारदइसे बनाने के लिए /plan-generate चलाएँ

उदाहरण

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

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

क्रॉस-संदर्भ

On this page