Spec-First Workflow
กำหนดข้อกำหนดก่อนการเขียนโค้ด
OpenSpecการพัฒนาที่ขับเคลื่อนด้วยข้อกำหนดสำหรับผู้ช่วย AI
ข้อกำหนดน้ำหนักเบาสำหรับการสร้างและจัดการโปรเจกต์ผู้ช่วย AI
ข้อกำหนดน้ำหนักเบาสำหรับการสร้างและจัดการโปรเจกต์ผู้ช่วย AI
ยินดีต้อนรับ นี่คือหน้าหลักของ OpenSpec ทุกอย่าง
OpenSpec ช่วยให้คุณและผู้ช่วยเขียนโค้ด AI ของคุณ เห็นพ้องต้องกันว่าต้องสร้างอะไรก่อนที่จะมีการเขียนโค้ดใด ๆ คุณอธิบายการเปลี่ยนแปลง, AI ร่างข้อกำหนดสั้น ๆ และรายการงาน, ทั้งคู่ดูแผนเดียวกัน จากนั้นงานจึงเกิดขึ้น ไม่ต้องมาค้นพบกลางคันว่า AI สร้างสิ่งที่ผิด
หากคุณไม่ได้อ่านสิ่งอื่นเลย โปรดอ่านสองหน้านี้:
/opsx:propose (คำแนะนำ: ในแชท AI ของคุณ ไม่ใช่ในเทอร์มินัล) นี่คือสิ่งที่ทำให้คนส่วนใหญ่สับสนหน้าสองมีความสำคัญมากกว่าที่เห็น OpenSpec มีสองส่วน: เครื่องมือบรรทัดคำสั่งที่คุณรันในเทอร์มินัล และ slash commands ที่คุณให้แก่ผู้ช่วย AI การรู้ว่าอันไหนคืออะไรจะช่วยประหยัดความสับสนที่พบบ่อยที่สุดได้
นิสัยที่ดีที่สุดที่ควรสร้างก่อน: เมื่อคุณไม่แน่ใจว่าจะสร้างอะไร ให้เริ่มต้นด้วย
/opsx:exploreมันเป็นคู่คิดในการคิดแบบไม่มีความเสี่ยง ซึ่งอ่านโค้ดของคุณ ชั่งน้ำหนักตัวเลือก และปรับความคิดที่ไม่ชัดเจนให้กลายเป็นแผนที่เป็นรูปธรรม ก่อนที่จะมีสิ่งประดิษฐ์หรือโค้ดใด ๆ คู่มือ Explore First ได้นำเสนอข้อพิสูจน์นี้
ฉันเป็นมือใหม่สุด ๆ เริ่มต้นด้วย Getting Started จากนั้นอ่านคร่าว ๆ ที่ Core Concepts at a Glance เมื่อมีบางอย่างที่รู้สึกว่าลึกลับ FAQ และ Glossary อยู่ใกล้ ๆ
ฉันมีปัญหาแต่ยังไม่มีแผน นี่คือกรณีทั่วไป และมีคำตอบเฉพาะ: Explore First ใช้ /opsx:explore เพื่อคิดผ่านปัญหานี้กับ AI ก่อนที่จะผูกมัดกับสิ่งใด ๆ
ฉันมีฐานโค้ดขนาดใหญ่ที่มีอยู่แล้ว คุณไม่จำเป็นต้องทำเอกสารทั้งหมดของมัน Using OpenSpec in an Existing Project แสดงให้เห็นวิธีเริ่มต้นบนโค้ดจริง (brownfield code) โดยไม่ต้องพยายามครอบคลุมทุกอย่าง
ฉันแค่อยากทำให้มันใช้งานได้ Install, รัน openspec init, จากนั้นอ่าน How Commands Work เพื่อให้ slash command แรกของคุณไปอยู่ในที่ที่ถูกต้อง
ฉันเรียนรู้จากการยกตัวอย่าง หน้า Examples & Recipes จะพาคุณชมการเปลี่ยนแปลงจริงตั้งแต่ต้นจนจบ: ฟีเจอร์เล็ก ๆ, การแก้ไขข้อบกพร่อง, การปรับโครงสร้างใหม่ (refactor), และการสำรวจ
ฉันมาจากขั้นตอนการทำงานแบบเก่า Migration Guide อธิบายว่าอะไรเปลี่ยนไปและทำไม และรับรองว่างานที่มีอยู่ของคุณปลอดภัย
ฉันต้องการปรับให้เข้ากับกระบวนการของทีม Customization ครอบคลุมการตั้งค่าโปรเจกต์, สคีมาที่กำหนดเอง, และบริบทที่ใช้ร่วมกัน
มีบางอย่างพัง Troubleshooting รวบรวมความล้มเหลวที่ผู้คนพบจริง พร้อมวิธีแก้ไข
| Doc | สิ่งที่คุณได้รับ |
|---|---|
| Getting Started | การติดตั้ง, การเริ่มต้นใช้งาน และการรันการเปลี่ยนแปลงครั้งแรกตั้งแต่ต้นจนจบ |
| Explore First | ใช้ /opsx:explore เพื่อคิดผ่านแนวคิดก่อนที่คุณจะผูกมัด |
| How Commands Work | สถานที่ที่ slash commands ทำงาน, ความหมายของ "interactive mode", เทอร์มินัลเทียบกับแชท |
| Core Concepts at a Glance | โมเดลความคิดทั้งหมดในหน้าเดียว: ข้อกำหนด (specs), การเปลี่ยนแปลง (changes), เดลต้า (deltas), คลังเก็บ (archive) |
| Installation | npm, pnpm, yarn, bun, Nix และวิธีตรวจสอบว่าทำงานแล้ว |
| Doc | สิ่งที่คุณได้รับ |
|---|---|
| Workflows | รูปแบบทั่วไปและเมื่อใดที่ควรใช้คำสั่งแต่ละตัว |
| Examples & Recipes | การนำเสนอการเปลี่ยนแปลงจริงทั้งหมด, สามารถคัดลอกได้ |
| Using OpenSpec in an Existing Project | การนำ OpenSpec มาใช้กับฐานโค้ดขนาดใหญ่ (brownfield codebase) |
| Editing & Iterating on a Change | อัปเดตสิ่งประดิษฐ์, ย้อนกลับ, ตกลงการแก้ไขด้วยตนเอง |
| Commands | เอกสารอ้างอิงสำหรับ slash command /opsx:* ทุกตัว |
| CLI | เอกสารอ้างอิงสำหรับคำสั่งเทอร์มินัล openspec ทุกตัว |
| Doc | สิ่งที่คุณได้รับ |
|---|---|
| Concepts | คำอธิบายแบบยาวของข้อกำหนด, การเปลี่ยนแปลง, สิ่งประดิษฐ์, สคีมา และคลังเก็บ |
| OPSX Workflow | เหตุผลที่ขั้นตอนการทำงานมีความยืดหยุ่นแทนที่จะถูกล็อกตามเฟส พร้อมเจาะลึกสถาปัตยกรรม |
| Glossary | คำศัพท์ทุกคำที่กำหนดไว้ในที่เดียว |
| Doc | สิ่งที่คุณได้รับ |
|---|---|
| Customization | การตั้งค่าโปรเจกต์, สคีมาที่กำหนดเอง, บริบทที่ใช้ร่วมกัน |
| Multi-Language | สร้างสิ่งประดิษฐ์ในภาษาอื่นที่ไม่ใช่ภาษาอังกฤษ |
| Supported Tools | เครื่องมือ AI 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 เกิดขึ้นในเทอร์มินัลของคุณ ส่วนที่เหลือเกิดขึ้นในแชทของผู้ช่วย AI การแยกส่วนนี้เป็นสิ่งเดียวที่คุ้มค่าแก่การจดจำ และ How Commands Work อธิบายอย่างชัดเจนว่าทำไม ขั้นตอนที่ 3 เป็นทางเลือก แต่การเริ่มต้นด้วย /opsx:explore เมื่อคุณไม่แน่ใจคือสิ่งที่ควรสร้างนิสัยมากที่สุด
openspec feedback "your message" ส่งความคิดเห็นโดยตรงจากเทอร์มินัลของคุณ (มันจะเปิด GitHub issue)พบสิ่งใดในเอกสารเหล่านี้ที่ผิด ล้าสมัย หรือสับสนหรือไม่? นั่นคือข้อบกพร่อง เปิดปัญหาหรือ PR การปรับปรุงเอกสารเป็นหนึ่งในการมีส่วนร่วมที่มีคุณค่าที่สุดที่คุณสามารถทำได้.