OpenSpec प्रलेखन ​

स्वागत है। यह OpenSpec के सभी कंटेंट का मुख्य पृष्ठ है।

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

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

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

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

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

अपना मार्ग चुनें ​

मैं पूरी तरह नया हूँ। शुरुआत करें से शुरुआत करें, फिर कोर कॉन्सेप्ट्स एक नजर में को झलक लें। जब कुछ रहस्यमय लगे, तो FAQ और शब्दकोश पास ही मौजूद हैं।

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

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

मैं बस इसे काम करने के लिए चाहता हूँ। इंस्टॉल करें, openspec init चलाएं, फिर कमांड कैसे काम करते हैं पढ़ें ताकि आपका पहला स्लैश कमांड सही जगह पर पहुंच जाए।

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

AI ने अभी एक योजना का मसौदा तैयार कर लिया है — अब क्या करें? इसे पढ़ें। एक परिवर्तन की समीक्षा करना दिखाता है कि कम लागत वाले रूप में गलत मोड़ को पकड़ने के लिए दो मिनट का पास क्या है, और अच्छे स्पेक लिखना बताता है कि मंजूर करने लायक योजना में क्या शामिल होता है।

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

मैं पुराने वर्कफ्लो से आ रहा हूँ। माइग्रेशन गाइड बताता है कि क्या बदला है और क्यों, और यह आश्वासन देता है कि आपका मौजूदा काम सुरक्षित है।

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

कुछ गड़बड़ हो गया है। ट्रबलशूटिंग उन सभी फेलियर्स को इकट्ठा करता है जो लोगों को वास्तव में आते हैं, उनके फिक्स के साथ।

पूरा मैप ​

यहां से शुरुआत करें ​

रोजमर्रा उपयोग में ​

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

इसे अपनाएं ​

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

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

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

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 असिस्टेंट के चैट में होते हैं। यह बंटन एकमात्र ऐसी चीज है जिसे याद रखने लायक है, और कमांड कैसे काम करते हैं बिल्कुल वही कारण बताता है। स्टेप 3 वैकल्पिक है, लेकिन जब आप अनिश्चित हों तो /opsx:explore से शुरुआत करना सबसे ज्यादा लायक आदत है।

मदद कहां और लें ​

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

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