Spec-First Workflow
कोड लिखने से पहले आवश्यकताओं को परिभाषित करें।
OpenSpecएआई असिस्टेंट्स के लिए स्पेसिफिकेशन-ड्रिवन डेवलपमेंट
एआई असिस्टेंट प्रोजेक्ट बनाने और प्रबंधित करने के लिए एक हल्का स्पेसिफिकेशन।
स्वागत है। यह ओपनस्पेक की हर चीज़ का घर है।
OpenSpec आपको और आपके एआई कोडिंग असिस्टेंट को कोई कोड लिखने से पहले इस बात पर सहमत होने में मदद करता है कि क्या बनाना है। आप बदलाव का वर्णन करते हैं, एआई एक छोटा स्पेसिफिकेशन और एक कार्य सूची तैयार करता है, आप दोनों उसी योजना को देखते हैं, और फिर काम होता है। अब बीच में यह पता लगाने की ज़रूरत नहीं है कि एआई ने गलत चीज़ बना दी है।
यदि आप कुछ और नहीं पढ़ते हैं, तो इन दो पृष्ठों को पढ़ें:
/opsx:propose टाइप करते हैं (संकेत: अपने एआई चैट में, टर्मिनल में नहीं)। यह लगभग हर किसी को एक बार भ्रमित करता है।दूसरा वाला पहले से कहीं ज़्यादा मायने रखता है। OpenSpec के दो भाग हैं: एक कमांड लाइन टूल जिसे आप अपने टर्मिनल में चलाते हैं, और स्लैश कमांड जो आप अपने एआई असिस्टेंट को देते हैं। जानना कि कौन सा क्या है, आपको सबसे आम भ्रम की स्थिति से बचाता है।
सबसे अच्छी आदत पहले बनाएं: जब आपको यकीन न हो कि क्या बनाना है, तो
/opsx:exploreके साथ शुरुआत करें। यह एक नो-स्टेक्स सोचने वाला साथी है जो आपके कोड को पढ़ता है, विकल्पों का मूल्यांकन करता है, और किसी भी कलाकृति या कोड के अस्तित्व से पहले एक अस्पष्ट विचार को एक ठोस योजना में बदल देता है। Explore First गाइड इस बात की पुष्टि करता है।
मैं बिल्कुल नया हूँ। Getting Started से शुरुआत करें, फिर Core Concepts at a Glance पर नज़र डालें। जब कुछ रहस्यमय लगे, तो FAQ और Glossary पास में हैं।
मुझे एक समस्या है लेकिन कोई योजना नहीं है। यह सामान्य मामला है, और इसका एक समर्पित उत्तर है: Explore First। किसी भी चीज़ के लिए प्रतिबद्ध होने से पहले एआई के साथ इसे सोचने के लिए /opsx:explore का उपयोग करें।
मेरे पास एक बड़ा मौजूदा कोडबेस है। आपको इसका सब कुछ दस्तावेज़ करने की ज़रूरत नहीं है। Using OpenSpec in an Existing Project दिखाता है कि समुद्र को उबाले बिना वास्तविक, ब्राउनफील्ड कोड पर कैसे शुरुआत करें।
मैं बस इसे काम करवाना चाहता हूँ। Install, openspec init चलाएँ, फिर How Commands Work पढ़ें ताकि आपका पहला स्लैश कमांड सही जगह पर लैंड हो।
मैं उदाहरणों से सीखता हूँ। Examples & Recipes पेज शुरुआत से अंत तक वास्तविक बदलावों के माध्यम से मार्गदर्शन करता है: एक छोटा फीचर, एक बग फिक्स, एक रीफ़ैक्टर, एक एक्सप्लोरेशन।
मैं पुराने वर्कफ़्लो से आ रहा हूँ। Migration Guide बताता है कि क्या बदला और क्यों, और वादा करता है कि आपका मौजूदा काम सुरक्षित है।
मैं इसे अपनी टीम की प्रक्रिया के अनुसार ढालना चाहता हूँ। Customization प्रोजेक्ट कॉन्फ़िगरेशन, कस्टम स्कीमा और साझा संदर्भ को कवर करता है।
कुछ टूटा हुआ है। Troubleshooting उन विफलताओं को इकट्ठा करता है जिनका लोग वास्तव में सामना करते हैं, साथ ही फिक्स भी देता है।
| Doc | यह आपको क्या देता है |
|---|---|
| Getting Started | एंड-टू-एंड अपना पहला बदलाव इंस्टॉल, इनिशियलाइज़ और चलाएँ |
| Explore First | कमिट करने से पहले किसी विचार को सोचने के लिए /opsx:explore का उपयोग करें |
| How Commands Work | स्लैश कमांड कहाँ चलते हैं, "इंटरैक्टिव मोड" का क्या मतलब है, टर्मिनल बनाम चैट |
| Core Concepts at a Glance | एक पेज पर पूरी मानसिक मॉडल: स्पेसिफिकेशन, बदलाव, डेल्टा, आर्काइव |
| Installation | npm, pnpm, yarn, bun, Nix और यह सत्यापित करने का तरीका कि यह काम कर गया है |
| Doc | यह आपको क्या देता है |
|---|---|
| Workflows | सामान्य पैटर्न और किस कमांड के लिए पहुँचना है |
| Examples & Recipes | वास्तविक बदलावों का पूरा विवरण, कॉपी-पेस्ट करने योग्य |
| Using OpenSpec in an Existing Project | एक बड़े ब्राउनफील्ड कोडबेस पर OpenSpec को अपनाना |
| Editing & Iterating on a Change | कलाकृतियों को अपडेट करें, वापस जाएँ, मैन्युअल संपादन का समाधान करें |
| Commands | हर /opsx:* स्लैश कमांड के लिए संदर्भ |
| CLI | हर openspec टर्मिनल कमांड के लिए संदर्भ |
| Doc | यह आपको क्या देता है |
|---|---|
| Concepts | स्पेसिफिकेशन, बदलाव, कलाकृतियों, स्कीमा और आर्काइव की लंबी व्याख्या |
| OPSX Workflow | क्यों वर्कफ़्लो चरण-लॉक के बजाय तरल है, साथ ही एक वास्तुकला गहन गोताखोरी |
| Glossary | हर शब्द एक जगह परिभाषित है |
| Doc | यह आपको क्या देता है |
|---|---|
| Customization | प्रोजेक्ट कॉन्फ़िगरेशन, कस्टम स्कीमा, साझा संदर्भ |
| Multi-Language | अंग्रेजी के अलावा अन्य भाषाओं में कलाकृतियाँ जनरेट करें |
| Supported Tools | 25+ एआई टूल जिनके साथ OpenSpec इंटीग्रेट होता है, और फाइलें कहाँ लैंड होती हैं |
| Doc | यह आपको क्या देता है |
|---|---|
| FAQ | लोगों द्वारा सबसे अधिक पूछे जाने वाले प्रश्नों के त्वरित उत्तर |
| Troubleshooting | ठोस विफलताओं के लिए ठोस फिक्स |
| Migration Guide | पुराने वर्कफ़्लो से OPSX में जाना |
| Doc | यह आपको क्या देता है |
|---|---|
| Stores: User Guide | जब आपका काम रिपॉ या टीमों तक फैला हो तो अपने स्वयं के रेपो में योजना बनाना |
| Agent Contract | मशीन-पठनीय CLI सतहें जिन्हें एजेंट चलाते हैं |
1. Install npm install -g @fission-ai/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (in your AI chat) /opsx:explore ← वैकल्पिक, लेकिन एक शानदार आदत
4. Propose (in your AI chat) /opsx:propose add-dark-mode
5. Build (in your AI chat) /opsx:apply
6. Archive (in your AI chat) /opsx:archiveचरण 1 और 2 आपके टर्मिनल में होते हैं। बाकी आपके एआई असिस्टेंट के चैट में होता है। यह विभाजन वह एक चीज़ है जिसे याद रखना लायक है, और How Commands Work ठीक यही बताता है। चरण 3 वैकल्पिक है, लेकिन जब आप अनिश्चित हों तो /opsx:explore से शुरुआत करना सबसे अधिक मूल्यवान आदत है।
openspec feedback "your message" सीधे आपके टर्मिनल से फीडबैक भेजता है (यह एक GitHub इशू खोलता है)।क्या आपको इन दस्तावेज़ों में कुछ गलत, पुराना या भ्रमित करने वाला मिलता है? वह एक बग है। एक इशू या PR खोलें। दस्तावेज़ीकरण सुधार आप जो सबसे मूल्यवान योगदान दे सकते हैं, उनमें से कुछ हैं।