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

/plan-design

/plan-design — `_inputs/design.md` पर एक व्यापक आर्किटेक्चरल-डिज़ाइन कलाकृति उत्पन्न करता है।

भूमिका: आर्किटेक्ट पाइपलाइन स्थिति: सशर्त, समीक्षा-पश्चात, निष्पादन-पूर्व

जब किसी प्लान सूट में आर्किटेक्चर-धारक कार्य हो, तब _inputs/design.md पर आर्किटेक्चरल-डिज़ाइन कलाकृति उत्पन्न करता है। यह जानबूझकर सशर्त है: एक गद्य, दस्तावेज़, मेटाडेटा, या संकीर्ण फ़िक्स्चर सूट /plan-review से सीधे /plan-execute तक बढ़ता है; जो सूट घटकों, इंटरफ़ेस, स्कीमा, डेटा प्रवाह, अडैप्टर, रिलीज़ टोपोलॉजी, सुरक्षा सीमाओं, या रनटाइम व्यवहार को बदलता है वह पहले /plan-design से होकर गुज़रता है।

विहित आह्वान

/plan-design path/to/plan-suite/

तर्कों के साथ:

/plan-design [path/to/plan-suite/] [--refine-existing] [--dry-run]

इनपुट

समीक्षित प्लान सूट + _spec/spec.md + _inputs/handoff-manifest.yml + /plan-review से PASS समीक्षा स्कोरकार्ड।

आउटपुट

_inputs/design.md के साथ एक संवर्धित _inputs/handoff-manifest.yml, जो डिज़ाइन कलाकृति का पथ, डिज़ाइन गेट का परिणाम, सात-अक्ष कवरेज का परिणाम, और द्विदिश बाइंडिंग मैट्रिक्स का सारांश वहन करता है।

प्रयोज्यता गेट

/plan-design तब चलाएँ जब कम-से-कम एक अनुप्रवाह फ़ेज़ निम्न में से कोई घोषित या निहित करे:

  • स्रोत-लेआउट, पैकेज-सीमा, अडैप्टर-सीमा, या मॉड्यूल-सीमा में परिवर्तन।
  • सार्वजनिक इंटरफ़ेस, प्रोटोकॉल, स्कीमा, कॉन्फ़िगरेशन अनुबंध, या CLI व्यवहार।
  • घटकों के बीच डेटा प्रवाह, जीवनचक्र क्रमबद्धता, स्थिति-संक्रमण, या निर्भरता किनारे।
  • सुरक्षा, प्रदर्शन, समवर्तीता, अवलोकनीयता, परिनियोजन, रिलीज़, या आपूर्ति-शृंखला आर्किटेक्चर।
  • एक बाद की /architecture-review पास जिसे कार्यान्वयन को वापस किसी डिज़ाइन कलाकृति तक ट्रेस करना चाहिए।

/plan-design को तब छोड़ें जब सूट प्रति-संपादन, उत्पन्न इन्वेंट्री रिफ़्रेश, संकीर्ण फ़िक्स्चर अपडेट, एक-बार के दस्तावेज़ सुधार, या अन्य ऐसे कार्य तक सीमित हो जिसका कार्यान्वयन किसी आर्किटेक्चरल ट्रेस सतह के बिना सत्यापित किया जा सके। छोड़ने का पथ स्पष्ट है: /plan-review गैर-आर्किटेक्चर वर्गीकरण को दर्ज करता है, फिर /plan-execute समीक्षित प्लान सूट से जारी रहता है।

अनुप्रवाह

/plan-execute आर्किटेक्चर-धारक फ़ेज़ों के लिए डिज़ाइन कलाकृति का उपभोग करता है। /architecture-review ऑडिट समीक्षा अनुक्रम के दौरान उसी कलाकृति का उपभोग करता है। यदि आर्किटेक्चर-धारक कार्य के लिए _inputs/design.md अनुपस्थित है, तो आर्किटेक्चर समीक्षा रुक जाती है और सूट को वापस /plan-design के माध्यम से रूट करती है।

वर्कफ़्लो फ़ेज़

यह कमांड छह आर्किटेक्चर-विशिष्ट रूपांतरण फ़ेज़ों का अनुसरण करता है:

  1. इनपुट अंतर्ग्रहण — समीक्षित सूट, स्कोरकार्ड, फ़ेज़ आउटपुट, और हैंडऑफ़ मैनिफ़ेस्ट को पढ़ता है; SHARED+ पर अनुपस्थित या विफल समीक्षा साक्ष्य पर अवरुद्ध करता है।
  2. आर्किटेक्चरल विघटन — आर्किटेक्चर, समवर्तीता, प्रदर्शन, सुरक्षा, परीक्षण, Tooling, और अवलोकनीयता की पड़ताल करता है; घटक, किनारे, और खुले आर्किटेक्चरल प्रश्न पहचानता है।
  3. घटक-इंटरफ़ेस डिज़ाइन — सार्वजनिक इंटरफ़ेस, प्रोटोकॉल अनुबंध, स्कीमा, अपरिवर्तनीयताएँ, विफलता-मोड, और निर्भरता-व्युत्क्रमण सीमाएँ परिभाषित करता है।
  4. घटक-अंतर बाइंडिंग अनुसमर्थन — हर ऊपरी-धारा, अनुप्रवाह, सहोदर, मानदंड, और एंकर किनारा बंद करता है; जब घटक ग्राफ़ मैट्रिक्स सीमा को पार करता है तब एक द्विदिश बाइंडिंग मैट्रिक्स उत्सर्जित करता है।
  5. डिज़ाइन कलाकृति उत्सर्जन — घटक खंडों, आरेखों, निर्णय अभिलेखों, सत्यापन परिणाम, और बाइंडिंग के साथ _inputs/design.md लिखता है।
  6. डिज़ाइन सत्यापन गेट — पंद्रह-बार पूर्व-उत्सर्जन गेट चलाता है; डिज़ाइन के उत्तीर्ण होने के बाद ही _inputs/handoff-manifest.yml को अद्यतन करता है।

डिज़ाइन कलाकृति का स्वरूप

उत्सर्जित _inputs/design.md में शामिल है:

  • घटक गणना और सात-अक्ष कवरेज के साथ कार्यकारी सारांश।
  • प्रति प्रमुख घटक एक खंड, भीतरी डोमेन सतहों से बाहरी अडैप्टरों और ऑपरेटर सतहों की ओर क्रमबद्ध।
  • Mermaid आर्किटेक्चर, अनुक्रम, स्थिति, या निर्भरता आरेख जहाँ संरचना अन्यथा अस्पष्ट होती।
  • विकल्पों, समझौतों, और प्रतिवर्तीयता टिप्पणियों के साथ निपटाए गए आर्किटेक्चरल निर्णय अभिलेख।
  • लागू होने पर सत्यापन-गेट परिणाम और द्विदिश बाइंडिंग मैट्रिक्स।
  • ऊपरी-धारा और अनुप्रवाह योजना सतहों की ओर कलाकृति की अपनी पाँच-दिश बाइंडिंग।

विफलता मोड

लक्षणकारणपुनर्प्राप्ति
पूर्वापेक्षा अपूर्णआश्रित फ़ेज़ समाप्त नहीं हुआपहले ऊपरी-धारा फ़ेज़ पूरा करें
गुणवत्ता गेट FAILआउटपुट मानकों को पूरा नहीं करताआउटपुट ठीक करें और पुनः चलाएँ
समीक्षित सूट अनुपस्थितप्लान सूट या समीक्षा स्कोरकार्ड अनुपस्थित/plan-generate, फिर /plan-review चलाएँ
गैर-आर्किटेक्चर सूटकिसी फ़ेज़ को आर्किटेक्चरल ट्रेस सतह की आवश्यकता नहींछोड़ने को दर्ज करें और /plan-execute पर जारी रखें
आर्किटेक्चर समीक्षा अवरुद्ध करती हैआर्किटेक्चर-धारक कार्यान्वयन के लिए _inputs/design.md अनुपस्थित/plan-design चलाएँ, फिर /architecture-review पुनः चलाएँ

उदाहरण

# Dry-run to preview applicability, component count, and open questions
/plan-design --dry-run

# Emit design for a named architecture-bearing suite
/plan-design path/to/plan-suite/

संदर्भ-सूत्र

On this page