OpenSpec दस्तावेज़ीकरण ​

स्वागत है। यह OpenSpec से जुड़ी हर चीज़ का मुख्य स्थान है।

OpenSpec आपको और आपके AI कोडिंग असिस्टेंट को कोड लिखे जाने से पहले यह तय करने में मदद करता है कि क्या बनाना है। आप परिवर्तन का विवरण देते हैं, AI एक छोटा स्पेक और कार्य सूची तैयार करता है, आप दोनों उसी योजना को देखते हैं, और फिर काम शुरू होता है। अब बीच में यह पता लगाने की समस्या नहीं रह गई कि AI ने गलत चीज़ बना दी है।

अगर आप कुछ भी नहीं पढ़ते, तो ये दो पेज ज़रूर पढ़ें:

1. शुरुआत: इंस्टॉल करें, इनिशियलाइज़ करें, और अपना पहला परिवर्तन शिप करें।
2. कमांड कैसे काम करते हैं: वह जगह जहाँ आप वास्तव में /opsx:propose टाइप करते हैं (संकेत: टर्मिनल में नहीं, बल्कि अपने AI चैट में)। यह लगभग हर किसी को एक बार भ्रमित कर देता है।

दूसरा पेज दिखने से ज़्यादा महत्वपूर्ण है। OpenSpec के दो हिस्से हैं: एक कमांड लाइन टूल जिसे आप अपने टर्मिनल में चलाते हैं, और स्लैश कमांड जो आप अपने AI असिस्टेंट को देते हैं। यह जानना कि कौन सा कौन सा है, आपको सबसे आम भ्रम के क्षण से बचा सकता है।

पहला बनाने के लिए सर्वोत्तम आदत: जब आपको यकीन न हो कि क्या बनाना है, तो /opsx:explore से शुरू करें। यह एक बिना जोखिम वाले विचार साथी है जो आपके कोड को पढ़ता है, विकल्पों पर विचार करता है, और किसी भी आर्टिफैक्ट या कोड मौजूद होने से पहले एक धुंधले विचार को एक ठोस योजना में बदल देता है। Explore First गाइड इसका समर्थन करती है।

अपना रास्ता चुनें ​

मैं पूरी तरह नया हूँ। शुरुआत से शुरू करें, फिर Core Concepts at a Glance को स्कैन करें। जब कुछ अस्पष्ट लगे, तो FAQ और Glossary पास ही उपलब्ध हैं।

मेरे पास कोई समस्या है लेकिन कोई योजना नहीं। यह सामान्य मामला है, और इसका एक समर्पित उत्तर है: Explore First। किसी भी बात को निश्चित करने से पहले AI के साथ विचार करने के लिए /opsx:explore का उपयोग करें।

मेरे पास एक बड़ा मौजूदा कोडबेस है। आप उसकी सभी दस्तावेज़ीकरण नहीं करते। Using OpenSpec in an Existing Project दिखाता है कि 'बॉइलिंग द ओशन' (बहुत अधिक काम) किए बिना वास्तविक, ब्राउनफ़ील्ड कोड पर कैसे शुरू करें।

मुझे बस इसे काम करना है। Install करें, openspec init चलाएं, फिर How Commands Work पढ़ें ताकि आपका पहला स्लैश कमांड सही जगह पर जाए। या AI-assisted install prompt के साथ सेटअप को अपने असिस्टेंट को सौंप दें।

मैं उदाहरणों से सीखता हूँ। Examples & Recipes पेज वास्तविक परिवर्तनों को शुरुआत से अंत तक दिखाता है: एक छोटा फीचर, एक बग फिक्स, एक रिफैक्टर, एक एक्सप्लोरेशन।

AI ने अभी एक योजना ड्राफ्ट की है — अब क्या करें? उसे पढ़ें। Reviewing a Change एक दो-मिनट की जाँच दिखाता है जो गलत मोड़ को तब पकड़ती है जब वह सस्ती होती है, और Writing Good Specs कवर करता है कि मंजूरी योग्य योजना किससे बनी होती है।

मैं एक टीम के साथ काम करता हूँ। OpenSpec on a Team दिखाता है कि एक परिवर्तन एक ब्रांच और पुल रिक्वेस्ट पर कैसे मैप होता है, और सह-कर्मचारी कोड से पहले योजना की समीक्षा कैसे करते हैं।

मैं पुराने वर्कफ़्लो से आ रहा हूँ। Migration Guide बताता है कि क्या बदला और क्यों, और वचन देता है कि आपका मौजूदा काम सुरक्षित है।

मैं इसे अपनी टीम की प्रक्रिया के अनुसार ढालना चाहता हूँ। Customization प्रोजेक्ट कॉन्फ़िगरेशन, कस्टम स्कीमा, और साझा संदर्भ को कवर करता है।

कुछ टूट गया है। Troubleshooting उन विफलताओं को एकत्र करता है जिनका लोग वास्तव में सामना करते हैं, उनके समाधान के साथ।

पूरा मानचित्र ​

यहाँ से शुरू करें ​

दैनिक उपयोग के लिए ​

गहराई से समझें ​

इसे अपना बनाएं ​

जब आपको मदद चाहिए ​

रिपो के बीच समन्वय (बीटा) ​

तीस सेकंड का संस्करण ​

1. Install        npm install -g @fission-ai/openspec@latest
2. Initialize     cd your-project && openspec init
3. Explore        (in your AI chat)  /opsx:explore           ← optional, but a great habit
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 आपके टर्मिनल में होते हैं। बाकी सब आपके AI असिस्टेंट की चैट में होते हैं। यह विभाजन वह एक चीज़ है जिसमें याद रखने लायक है, और How Commands Work सटीक रूप से बताता है कि क्यों। चरण 3 वैकल्पिक है, लेकिन जब आप अनिश्चित हों तो /opsx:explore से शुरू करना वह आदत है जिसे बनाना सबसे ज़्यादा मूल्यवान है।

मदद कहाँ से पाएं ​

• Discord: सवालों, विचारों और मदद के लिए discord.gg/YctCnvvshC।
• GitHub Issues: बग और फीचर अनुरोधों के लिए github.com/Fission-AI/OpenSpec/issues।
• openspec feedback "your message" टर्मिनल से सीधे फीडबैक भेजता है (यह एक GitHub खोलता है)।

इन दस्तावेज़ों में कुछ गलत, पुराना या भ्रामक मिला? यह एक बग है। एक इश्यु या PR खोलें। दस्तावेज़ीकरण में सुधार वे योगदान हैं जो आप कर सकते हैं, उनमें से कुछ सबसे मूल्यवान हैं।