เอกสารประกอบ OpenSpec ​

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

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

หากคุณอ่านแค่ส่วนนี้อย่างเดียว ก็อ่านสองหน้านี้:

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

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

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

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

ฉันใหม่ทั้งหมด เริ่มต้นด้วย เริ่มต้นใช้งาน แล้วดูเบื้องต้น แนวคิดหลักโดยสังเขป เมื่อเจอสิ่งที่ยังไม่เข้าใจ คำถามที่พบบ่อย และ พจนานุกรม จะอยู่ใกล้ๆ

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

ฉันมีโค้ดเดิมขนาดใหญ่ คุณไม่จำเป็นต้องสร้างเอกสารทั้งหมด การใช้ OpenSpec ในโปรเจกต์ที่มีอยู่แล้ว แสดงวิธีเริ่มต้นกับโค้ด brownfield จริงๆ โดยไม่ต้องพยายามทำทุกอย่างในครั้งเดียว

ฉันแค่ต้องการให้มันทำงานได้ ติดตั้ง รันคำสั่ง openspec init แล้วอ่าน วิธีทำงานของคำสั่ง เพื่อให้คำสั่งสแลชแรกของคุณถูกส่งไปยังสถานที่ที่ถูกต้อง

ฉันเรียนรู้จากตัวอย่าง หน้า ตัวอย่างและสูตรสำเร็จ จะพาคุณผ่านการเปลี่ยนแปลงจริงตั้งแต่ต้นจนจบ: ฟีเจอร์เล็กๆ แก้ไขบั๊ก รีแฟกเตอร์ และการสำรวจ

AI เพิ่งร่างแผนงานแล้ว ตอนนี้ทำอะไร? อ่านมัน ตรวจสอบการเปลี่ยนแปลง แสดงวิธีตรวจสอบในสองนาทีที่ช่วยให้คุณพบกับทางเลือกที่ผิดก่อนที่จะเสียค่าใช้จ่าย และ การเขียนข้อกำหนดที่ดี อธิบายองค์ประกอบของแผนงานที่คุ้มค่าที่จะอนุมัติ

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

ฉันมาจากเวิร์กโฟลว์เก่า คู่มือการย้ายข้อมูล อธิบายสิ่งที่เปลี่ยนแปลงและเหตุผล และรับรองว่าประโยชน์เดิมของคุณยังคงอยู่

ฉันต้องการปรับให้เหมาะกับกระบวนการของทีม การปรับแต่ง อธิบายการกำหนดค่าโปรเจกต์ สคีมที่กำหนดเอง และบริบทที่ใช้ร่วมกัน

มีอะไรผิดพลาด การแก้ปัญหา รวบรวมปัญหาที่คนส่วนใหญ่พบจริงๆ พร้อมวิธีแก้

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

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

ใช้ในชีวิตประจำวัน ​

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

ปรับให้เหมาะกับคุณ ​

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

ประสานงานระหว่าง repos (เบต้า) ​

เวอร์ชันที่อ่านได้ใน 30 วินาที ​

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

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