Skip to content

OpenSpecการพัฒนาแบบ Specification-Driven สำหรับ AI Assistants

สเปกแบบเบาสำหรับสร้างและจัดการโปรเจกต์ AI Assistant

เอกสาร OpenSpec ​

ยินดีต้อนรับ นี่คือแหล่งรวมข้อมูลทุกอย่างเกี่ยวกับ OpenSpec

OpenSpec ช่วยให้คุณและ AI coding assistant ของคุณ ตกลงกันว่าจะสร้างอะไรก่อนเขียนโค้ดแม้แต่บรรทัดเดียว คุณอธิบายการเปลี่ยนแปลง AI ร่างสเปกสั้น ๆ และรายการงานขึ้นมา ทั้งสองฝ่ายดูแผนเดียวกัน แล้วจึงเริ่มทำงาน ไม่ต้องมาพบว่า AI สร้างผิดตั้งแต่ครึ่งทางอีกต่อไป

ถ้าคุณอ่านแค่สองหน้า อ่านหน้านี้ก่อน:

  1. เริ่มต้นใช้งาน: ติดตั้ง เริ่มต้น และส่งการเปลี่ยนแปลงแรกของคุณ
  2. คำสั่งทำงานอย่างไร: ที่ที่คุณพิมพ์ /opsx:propose จริง ๆ (คำตอบ: ในแชท AI ของคุณ ไม่ใช่ในเทอร์มินัล) เกือบทุกคนติดตรงนี้ครั้งแรก

หน้าที่สองสำคัญกว่าที่เห็น OpenSpec มีสองส่วน: เครื่องมือ command line ที่คุณรันในเทอร์มินัล และ slash commands ที่คุณสั่งให้ AI assistant ของคุณ การรู้ว่าอันไหนเป็นอันไหนช่วยประหยัดเวลาจากความสับสนที่พบบ่อยที่สุด

นิสัยที่ดีที่สุดที่จะสร้างก่อน: เมื่อไม่แน่ใจว่าจะสร้างอะไร เริ่มด้วย /opsx:explore เป็นคู่คิดแบบไม่มีความเสี่ยงที่อ่านโค้ดของคุณ ชั่งน้ำหนักตัวเลือก และทำให้ไอเดียที่คลุมเครือกลายเป็นแผนที่เป็นรูปธรรมก่อนจะมี artifact หรือโค้ดใด ๆ คู่มือ Explore First อธิบายเหตุผล

เลือกเส้นทางของคุณ ​

ใหม่ تمامًا. เริ่มจาก เริ่มต้นใช้งาน แล้วอ่าน Core Concepts at a Glance สักคร่าว ๆ เมื่ออะไรบางอย่างดูน่าสงสัย FAQ และ Glossary อยู่ใกล้ ๆ

มีปัญหาแต่ไม่มีแผน. นี่คือกรณีทั่วไป และมีคำตอบเฉพาะ: Explore First ใช้ /opsx:explore เพื่อคิดผ่านกับ AI ก่อนตัดสินใจอะไร

มีโค้ดเบสเดิมขนาดใหญ่. ไม่ต้องเขียนเอกสารทั้งหมด Using OpenSpec in an Existing Project แสดงวิธีเริ่มทำงานบนโค้ดจริงแบบ brownfield โดยไม่ต้องทำทุกอย่างพร้อมกัน

แค่อยากให้ได้ใช้งาน. ติดตั้ง รัน openspec init แล้วอ่าน คำสั่งทำงานอย่างไร เพื่อให้ slash command แรกของคุณไปถูกที่ หรือให้ AI assistant จัดการการตั้งค่าด้วย AI-assisted install prompt

เรียนรู้จากตัวอย่าง. หน้า Examples & Recipes อธิบายการเปลี่ยนแปลงจริงตั้งแต่ต้นจนจบ: ฟีเจอร์เล็ก ๆ การแก้บั๊ก การ refactor และการสำรวจ

AI ร่างแผนมาแล้ว — แล้วต่อไป? อ่านมัน Reviewing a Change แสดงการตรวจสองนาทีที่จับจุดผิดได้ก่อนจะสาย และ Writing Good Specs ครอบคลุมว่าแผนที่ดีพอจะอนุมัติประกอบด้วยอะไร

ทำงานเป็นทีม. OpenSpec on a Team แสดงว่าการเปลี่ยนแปลงเชื่อมโยงกับ branch และ pull request อย่างไร และเพื่อนร่วมทีมตรวจแผนก่อนโค้ดอย่างไร

มาจาก workflow เดิม. Migration Guide อธิบายว่าอะไรเปลี่ยนไปและทำไม พร้อมการรับประกันว่างานเดิมของคุณปลอดภัย

อยากปรับให้เข้ากับกระบวนการของทีม. Customization ครอบคลุม project config, custom schemas และ shared context

อะไรบางอย่างพัง. Troubleshooting รวบรวมปัญหาที่คนเจอจริง พร้อมวิธีแก้

แผนที่ทั้งหมด ​

เริ่มที่นี่ ​

เอกสารสิ่งที่คุณจะได้
เริ่มต้นใช้งานติดตั้ง เริ่มต้น และรันการเปลี่ยนแปลงแรกจากต้นจนจบ
Explore Firstใช้ /opsx:explore เพื่อคิดผ่านไอเดียก่อนตัดสินใจ
คำสั่งทำงานอย่างไรSlash commands รันที่ไหน "interactive mode" หมายความว่าอะไร เทอร์มินัล vs แชท
Core Concepts at a Glanceภาพรวม mental model ทั้งระบบในหน้าเดียว: specs, changes, deltas, archive
Installationnpm, pnpm, yarn, bun, Nix, prompt ที่ให้ AI assistant จัดการการตั้งค่า และวิธีตรวจสอบว่าทำงานได้

ใช้ทุกวัน ​

เอกสารสิ่งที่คุณจะได้
Workflowsรูปแบบการใช้งานทั่วไปและเมื่อไหร่ควรใช้คำสั่งใด
Examples & RecipesWalkthrough เต็มรูปแบบของการเปลี่ยนแปลงจริง คัดลอก-วางได้ทันที
Writing Good Specsความต้องการและ scenario ที่แข็งแกร่งเป็นอย่างไร และวิธีกำหนดขนาดการเปลี่ยนแปลงให้เหมาะสม
Reviewing a Changeการตรวจสองนาทีบนแผนที่ร่างไว้ก่อนเขียนโค้ด
OpenSpec on a Teamการเปลี่ยนแปลงเชื่อมโยงกับ branches, pull requests และการ review อย่างไร
Using OpenSpec in an Existing Projectนำ OpenSpec มาใช้บนโค้ดเบส brownfield ขนาดใหญ่
Editing & Iterating on a Changeอัปเดต artifacts ย้อนกลับ และปรับแก้การแก้ไขด้วยมือ
Commandsอ้างอิงสำหรับทุก slash command /opsx:*
CLIอ้างอิงสำหรับทุก terminal command ของ openspec

เข้าใจอย่างลึกซึ้ง ​

เอกสารสิ่งที่คุณจะได้
Conceptsคำอธิบายแบบยาวเกี่ยวกับ specs, changes, artifacts, schemas และ archive
OPSX Workflowทำไม workflow จึงเป็นแบบไหลลื่นแทนที่จะล็อกเฟส พร้อมเจาะลึกสถาปัตยกรรม
Glossaryนิยามทุกคำศัพท์ในที่เดียว

ทำให้เป็นของคุณ ​

เอกสารสิ่งที่คุณจะได้
CustomizationProject config, custom schemas, shared context
Multi-Languageสร้าง artifacts ในภาษาอื่นที่ไม่ใช่ภาษาอังกฤษ
Supported Toolsเครื่องมือ AI กว่า 30 ตัวที่ OpenSpec รองรับ และไฟล์ไปอยู่ที่ไหน
Community Showcaseโปรเจกต์และทรัพยากรที่สร้างด้วยและเพื่อ OpenSpec

เมื่อต้องการความช่วยเหลือ ​

เอกสารสิ่งที่คุณจะได้
FAQคำตอบสั้น ๆ สำหรับคำถามที่พบบ่อยที่สุด
Troubleshootingวิธีแก้เฉพาะสำหรับปัญหาเฉพาะ
Migration Guideย้ายจาก workflow เก่าไป OPSX

ประสานงานข้าม repos (beta) ​

เอกสารสิ่งที่คุณจะได้
Stores: User Guideวางแผนใน repo ของตัวเองเมื่อการทำงานข้าม repos หรือทีม
Agent ContractCLI surfaces แบบ machine-readable ที่ agents ควบคุม

เวอร์ชัน 30 วินาที ​

text
1. ติดตั้ง        npm install -g @fission-ai/openspec@latest
2. เริ่มต้น     cd your-project && openspec init
3. สำรวจ        (ในแชท AI ของคุณ)  /opsx:explore           ← เลือกทำ แต่เป็นนิสัยที่ดีมาก
4. เสนอ          (ในแชท AI ของคุณ)  /opsx:propose add-dark-mode
5. สร้าง          (ในแชท AI ของคุณ)  /opsx:apply
6. เก็บ          (ในแชท AI ของคุณ)  /opsx:archive

ขั้นตอน 1 และ 2 เกิดขึ้นในเทอร์มินัลของคุณ ส่วนที่เหลือเกิดขึ้นในแชทของ AI assistant ของคุณ การแบ่งแบบนี้คือสิ่งเดียวที่ควรจำ และ คำสั่งทำงานอย่างไร อธิบายเหตุผลอย่างละเอียด ขั้นตอนที่ 3 เป็นตัวเลือก แต่การเริ่มด้วย /opsx:explore เมื่อไม่แน่ใจคือนิสัยที่ควรสร้างมากที่สุด

ที่อื่น ๆ ที่ขอความช่วยเหลือได้ ​

  • Discord: discord.gg/YctCnvvshC สำหรับคำถาม ไอเดีย และความช่วยเหลือ
  • GitHub Issues: github.com/Fission-AI/OpenSpec/issues สำหรับบั๊กและการขอฟีเจอร์
  • openspec feedback "your message" ส่ง feedback จากเทอร์มินัลโดยตรง (จะเปิด GitHub issue ให้)

พบอะไรในเอกสารเหล่านี้ที่ผิด เก่า หรือสับสน? นั่นคือบั๊ก เปิด issue หรือ PR ได้เลย การปรับปรุงเอกสารคือการมีส่วนร่วมที่มีคุณค่ามากที่สุดอย่างหนึ่งที่คุณทำได้