سير عمل يعتمد على المواصفات أولاً
حدد المتطلبات قبل كتابة الكود.
مواصفات خفيفة لبناء وإدارة مشاريع مساعدي الذكاء الاصطناعي.
مرحباً بكم. هذه هي الصفحة الرئيسية لكل ما يتعلق بـ OpenSpec.
يساعدك OpenSpec أنت ومساعد البرمجة بالذكاء الاصطناعي الخاص بك على الاتفاق على ما يجب بناؤه قبل كتابة أي كود. أنت تصف التغيير، ويقوم الذكاء الاصطناعي بصياغة مواصفات قصيرة وقائمة مهام، وكلا الطرفين ينظران إلى نفس الخطة، ثم يتم العمل. لا مزيد من الاكتشاف في منتصف الطريق بأن الذكاء الاصطناعي بنى الشيء الخطأ.
إذا لم تقرأ أي شيء آخر، فاقرأ هاتين الصفحتين:
/opsx:propose (تلميح: في محادثة الذكاء الاصطناعي الخاص بك، وليس في الطرفية). هذا يربك الجميع تقريباً مرة واحدة.الأمر الثاني أكثر أهمية مما يبدو عليه. يحتوي OpenSpec على نصفين: أداة سطر أوامر تقوم بتشغيلها في طرفيتك، وأوامر الشرطة (slash commands) التي تقدمها لمساعد الذكاء الاصطناعي الخاص بك. معرفة أي منهما هو ما يوفر لك لحظة الارتباك الأكثر شيوعاً.
العادة الأفضل لبنائها أولاً: عندما لا تكون متأكدًا مما يجب بناؤه، ابدأ بـ
/opsx:explore. إنه شريك تفكير بدون مخاطر يقرأ الكود الخاص بك، ويوازن الخيارات، ويصقل فكرة غامضة إلى خطة ملموسة قبل وجود أي مُنتج أو كود. دليل Explore First يقدم الحجة.
أنا جديد تماماً. ابدأ بـ Getting Started، ثم تصفح Core Concepts at a Glance. عندما تشعر بأن شيئًا ما غامض، فإن صفحة FAQ وGlossary قريبة.
لدي مشكلة ولكن ليس لدي خطة. هذه هي الحالة الشائعة، ولها إجابة مخصصة: Explore First. استخدم /opsx:explore للتفكير في الأمر مع الذكاء الاصطناعي قبل الالتزام بأي شيء.
لدي قاعدة كود كبيرة وموجودة بالفعل. أنت لا توثق كل شيء فيها. يوضح Using OpenSpec in an Existing Project كيفية البدء في الكود الحقيقي، غير المكتمل (brownfield)، دون محاولة حل مشكلة الكون بأكمله.
أريد فقط أن أجعله يعمل. Install، ثم قم بتشغيل openspec init، ثم اقرأ How Commands Work حتى تهبط أول أمر شرطة في المكان الصحيح.
أتعلّم من الأمثلة. تعرض صفحة Examples & Recipes تغييرات حقيقية من البداية إلى النهاية: ميزة صغيرة، إصلاح خطأ، إعادة هيكلة (refactor)، واستكشاف.
أنا قادم من سير العمل القديم. يشرح Migration Guide ما الذي تغير ولماذا، ويعد بأن عملك الحالي آمن.
أريد تكييفه ليناسب عملية فريقي. يغطي Customization إعدادات المشروع والمخططات المخصصة والسياق المشترك.
شيء ما معطّل. يجمع Troubleshooting حالات الفشل التي يصادفها الناس بالفعل، مع الإصلاحات.
| الوثيقة | ما تقدمه لك |
|---|---|
| Getting Started | التثبيت والتهيئة وتشغيل أول تغيير لديك من البداية إلى النهاية |
| Explore First | استخدام /opsx:explore للتفكير في فكرة قبل الالتزام بها |
| How Commands Work | المكان الذي تعمل فيه أوامر الشرطة، وماذا يعني "الوضع التفاعلي"، والطرفية مقابل الدردشة |
| Core Concepts at a Glance | النموذج العقلي الكامل في صفحة واحدة: المواصفات، والتغييرات، والمقاييس (deltas)، والأرشيف |
| Installation | npm و pnpm و yarn و bun و Nix وكيفية التحقق من عمله |
| الوثيقة | ما تقدمه لك |
|---|---|
| Workflows | الأنماط الشائعة ومتى تلجأ إلى كل أمر |
| Examples & Recipes | شروحات كاملة لتغييرات حقيقية، قابلة للنسخ واللصق |
| Using OpenSpec in an Existing Project | تبني OpenSpec في قاعدة كود كبيرة وموجودة بالفعل (brownfield) |
| Editing & Iterating on a Change | تحديث المخرجات، والعودة للخلف، وتسوية التعديلات اليدوية |
| Commands | مرجع لكل أمر شرطة /opsx:* |
| CLI | مرجع لكل أمر طرفية openspec |
| الوثيقة | ما تقدمه لك |
|---|---|
| Concepts | الشرح المطول للمواصفات، والتغييرات، والمخرجات (artifacts)، والمخططات، والأرشيف |
| OPSX Workflow | لماذا سير العمل مرن بدلاً من أن يكون مقيداً بمراحل، بالإضافة إلى تعميق معماري |
| Glossary | كل مصطلح مُعرّف في مكان واحد |
| الوثيقة | ما تقدمه لك |
|---|---|
| Customization | إعدادات المشروع، والمخططات المخصصة، والسياق المشترك |
| Multi-Language | إنشاء مخرجات بلغات أخرى غير الإنجليزية |
| Supported Tools | أدوات الذكاء الاصطناعي التي يدعمها OpenSpec (أكثر من 25 أداة)، وأين تهبط الملفات |
| الوثيقة | ما تقدمه لك |
|---|---|
| FAQ | إجابات سريعة للأسئلة التي يسألها الناس أكثر من غيرها |
| Troubleshooting | إصلاحات ملموسة لفشل ملموس |
| Migration Guide | الانتقال من سير العمل القديم إلى OPSX |
| الوثيقة | ما تقدمه لك |
|---|---|
| Stores: User Guide | التخطيط في مستودع خاص عندما يمتد عملك ليشمل مستودعات أو فرقاً متعددة |
| Agent Contract | الواجهات البرمجية (CLI surfaces) التي تديرها الوكلاء والتي يمكن قراءتها آلياً |
1. Install npm install -g @fission-ai/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (في محادثة الذكاء الاصطناعي الخاص بك) /opsx:explore ← اختياري، ولكنه عادة رائعة
4. Propose (في محادثة الذكاء الاصطناعي الخاص بك) /opsx:propose add-dark-mode
5. Build (في محادثة الذكاء الاصطناعي الخاص بك) /opsx:apply
6. Archive (في محادثة الذكاء الاصطناعي الخاص بك) /opsx:archiveتحدث الخطوتان 1 و 2 في طرفيتك. أما البقية فتتم في دردشة مساعد الذكاء الاصطناعي الخاص بك. هذا التقسيم هو الشيء الوحيد الذي يستحق الحفظ، ويشرحه How Commands Work بالتحديد. الخطوة 3 اختيارية، لكن البدء بـ /opsx:explore عندما تكون غير متأكد هو العادة الأكثر قيمة لتكوينها.
openspec feedback "رسالتك" يرسل الملاحظات مباشرة من طرفيتك (يفتح مشكلة في GitHub).هل وجدت شيئًا خاطئًا أو قديماً أو مربكاً في هذه الوثائق؟ هذا خطأ. افتح مشكلة أو طلب سحب (PR). تحسينات التوثيق هي بعض المساهمات الأكثر قيمة التي يمكنك تقديمها.