spec-mode 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,144 @@
+# Spec Mode
+
+> **Specs first, code second.**
+
+![OpenCode Compatible](https://img.shields.io/badge/OpenCode-Compatible-blue)
+![License](https://img.shields.io/badge/license-Apache--2.0-green)
+![Version](https://img.shields.io/badge/version-1.0.0-orange)
+
+**A professional specification-first development workflow for AI assistants.**
+
+Inspired by Trae's spec-mode-skill, this skill brings enterprise-grade specification practices to your AI coding workflow.
+
+**Compatible with:** OpenCode, Cursor, Windsurf, Copilot
+
+## Overview
+
+Spec Mode creates three standardized documents before starting any complex development task:
+
+- **spec.md** - What & Why (requirements, scope, impact)
+- **tasks.md** - How to implement (breakdown into verifiable work items)
+- **checklist.md** - Verification checkpoints (acceptance criteria)
+
+## Why Spec Mode?
+
+| Problem | Spec Mode Solution |
+|---------|-------------------|
+| ❌ AI writes code without understanding requirements | ✅ Creates detailed spec.md first |
+| ❌ Vague requirements lead to rework | ✅ Clear acceptance criteria in checklist.md |
+| ❌ Hard to track progress on large tasks | ✅ Task breakdown in tasks.md |
+| ❌ No documentation for handoff | ✅ Professional spec documents |
+| ❌ Scope creep during implementation | ✅ Defined scope before coding starts |
+
+## Installation
+
+### Option 1: Install via npm
+
+```bash
+npx skills add spec-mode --skill spec-mode
+```
+
+### Option 2: Install via GitHub
+
+```bash
+npx skills add GlacierXiaowei/spec-mode --skill spec-mode
+```
+
+### Option 3: Manual Installation
+
+1. Clone or download this repository
+2. Copy the skill folder to your AI assistant's skills directory
+3. Restart your AI assistant
+
+## Usage
+
+Trigger Spec Mode by saying any of these phrases:
+
+- "spec"
+- "specification"
+- "spec-mode"
+- "写规范"
+- "写 specs"
+
+### Example
+
+```
+User: Let's build a user login system, use spec-mode
+```
+
+## When to Use
+
+### ✅ Suitable for:
+
+- Large features (login system, order flow, message center)
+- Multi-file/module changes
+- Vague requirements ("optimize experience", "refactor homepage")
+- Need clear acceptance criteria
+- Team collaboration or handoff
+- High-risk changes (compatibility, permissions, payment, data migration)
+
+### ❌ Not needed for:
+
+- Small fixes (copy, spacing, minor bugs)
+- Clear requirements ("change button text from A to B")
+- One-time exploration
+- Pure explanation tasks
+
+**Rule of thumb:** Small/clear/low-risk → optional spec. Large/vague/risky → use spec.
+
+## Output Structure
+
+```
+<project-root>/.specs/<change-id>/
+├── spec.md        # Requirements and scope
+├── tasks.md       # Implementation tasks
+└── checklist.md   # Verification checkpoints
+```
+
+### Document Contents
+
+#### spec.md
+
+- Why (business goal)
+- What (changes overview)
+- Impact analysis
+- ADDED/MODIFIED/REMOVED sections
+
+#### tasks.md
+
+- Small verifiable work items
+- Dependencies between tasks
+- Estimated effort
+
+#### checklist.md
+
+- Must-pass checkpoints
+- Itemized & checkable criteria
+- Acceptance tests
+
+## Core Rules
+
+### The Iron Rule
+
+> **SPECS FIRST, CODE SECOND. NEVER SKIP SPEC PHASE.**
+
+### What Spec Mode Forbids
+
+- ❌ Writing code before specs are approved
+- ❌ Skipping user review
+- ❌ Modifying code "just a little bit"
+- ❌ Scanning code before specs (scan AFTER specs for implementation)
+
+## License
+
+Apache-2.0
+
+## Author
+
+**Glacier Xiaowei**
+- GitHub: [@GlacierXiaowei](https://github.com/GlacierXiaowei)
+- Email: glacier_xiaowei@163.com
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

package/SKILL.md

@@ -0,0 +1,189 @@
+---
+name: spec-mode
+description: Use when user explicitly says "spec", "specification", "spec-mode", "写规范", "写 specs". Main entry skill that creates three spec documents (spec.md, tasks.md, checklist.md) and coordinates implementation. Suitable for complex long-term tasks.
+---
+
+# Spec Mode
+
+## Overview
+
+Spec Mode creates three standardized documents before implementation: `spec.md`, `tasks.md`, `checklist.md`.
+
+**Core principle:** specs first, code second
+
+**Use for:** Complex long-term tasks requiring clear specifications.
+
+**Benefits:** Less rework, fewer misunderstandings, easy tracking, clear acceptance.
+
+## When to Use
+
+**Trigger:** User explicitly says "spec", "specification", "spec-mode", "写规范", "写 specs".
+
+**Suitable for:**
+- Large features (login system, order flow, message center)
+- Multi-file/module changes
+- Vague requirements ("optimize experience", "refactor homepage")
+- Need clear acceptance criteria
+- Team collaboration or handoff
+- High-risk changes (compatibility, permissions, payment, data migration)
+
+**Not needed for:**
+- Small fixes (copy, spacing, minor bugs)
+- Clear requirements ("change button text from A to B")
+- One-time exploration
+- Pure explanation tasks
+
+**Rule of thumb:** Small/clear/low-risk → optional spec. Large/vague/risky → use spec.
+
+**Key principle:** This skill is ONLY loaded by explicit user request.
+
+## Quick Reference
+
+| Document | Purpose | Key Sections |
+|----------|---------|--------------|
+| `spec.md` | What & Why | Why, What Changes, Impact, ADDED/MODIFIED/REMOVED |
+| `tasks.md` | How to implement | Small verifiable work items with dependencies |
+| `checklist.md` | Verification | Must-pass checkpoints, itemized & checkable |
+
+**Output directory:** `<project-root>/.specs/<change-id>/`
+
+**Naming:** `<change-id>` uses verb-first, hyphen-separated (e.g., `add-user-export`, `refactor-auth-middleware`)
+
+## Core Rules
+
+**The Iron Law:**
+
+```
+SPECS FIRST, CODE SECOND. NEVER SKIP SPEC PHASE.
+```
+
+**Violating the letter of the rules is violating the spirit of the rules.**
+
+### What Spec Mode Produces
+
+1. **spec.md** - The specification document
+2. **tasks.md** - Implementation tasks breakdown
+3. **checklist.md** - Verification checkpoints
+
+### What Spec Mode Forbids
+
+- ❌ Writing code before specs approved
+- ❌ Skipping user review
+- ❌ Modifying code "just a little"
+- ❌ Scanning code before specs (scan AFTER specs for implementation)
+
+**No exceptions:** Delete means delete.
+
+## Common Mistakes
+
+See `references/common-mistakes.md` for:
+- Rationalizations to Resist (table)
+- Red Flags - STOP and Start Over
+- Why these mistakes happen
+- How to avoid them
+
+## FIRST RESPONSE RULE
+
+**After spec-mode triggers:**
+
+1. Understand user goal
+2. **Scan context first** (code structure, conventions, related files)
+3. Make reasonable assumptions when possible
+4. **Ask ONLY when:**
+   - Cannot infer after scanning
+   - AND it affects spec/implementation direction/scope/result
+
+**Ask about (3 types only):**
+- Vague requirements ("optimize homepage" - which aspect?)
+- Multiple valid approaches (permission system: role-based vs resource-level)
+- Unclear scope (frontend only / backend only / both)
+
+**WRONG:** Mechanical 3-5 questions, asking about minors, asking before scanning
+**RIGHT:** Scan → Infer → Ask only if critical → Write specs
+
+## AFTER CREATING SPECS RULE
+
+**After creating all three documents:**
+
+1. List the three files with paths
+2. Summarize key content
+3. **Use notification (not questions)**
+4. STOP - Wait for user confirmation
+
+**Correct format:**
+```
+✅ 已完成规范文档：
+- .specs/<change-id>/spec.md
+- .specs/<change-id>/tasks.md
+- .specs/<change-id>/checklist.md
+
+[简要总结关键内容]
+
+请审阅。确认后我开始实现。
+```
+
+**WRONG:** Starting implementation immediately
+**RIGHT:** Create specs → Notify → Wait → Implement
+
+## Workflow
+
+**Flow:** User Request → Scan Context → Ask (if critical) → Create 3 docs → Notify → Wait → Implement
+
+**Step-by-step:**
+1. Understand & Scan
+2. Ask (only if critical)
+3. Create spec.md, tasks.md, checklist.md
+4. Notify user (notification format)
+5. Wait for confirmation
+6. Implement without interruption
+
+See `references/workflow-details.md` for complete diagram and details.
+
+## USER CONFIRMATION REQUIRED
+
+**After creating documents, use this format:**
+
+```
+✅ 已完成规范文档：
+- .specs/<change-id>/spec.md
+- .specs/<change-id>/tasks.md
+- .specs/<change-id>/checklist.md
+
+[简要总结关键内容]
+
+请审阅。确认后我开始实现。
+```
+
+**Before confirmation, DO NOT:** Write code, modify files, or implement.
+
+**Note:** Scanning code happens BEFORE specs (for context), not after confirmation.
+
+## AFTER USER CONFIRMATION
+
+**After user confirms:**
+
+1. **Implement directly, no more questions**
+2. Make judgments on uncertainties yourself
+3. Report when complete
+4. Interrupt only for major deviations
+
+**WRONG:** Asking about every small decision
+**RIGHT:** Execute → Report when done
+
+## Resources
+
+**Prompts:** `prompts/standard.md`, `prompts/workflow.md`
+
+**Templates:** `templates/spec-template.md`, `templates/tasks-template.md`, `templates/checklist-template.md`
+
+**Examples:** `examples/sample-spec.md`
+
+**Testing:** `tests/pressure-scenarios.md`
+
+## Cross-Platform Notes
+
+See `references/cross-platform.md` for:
+- Directory flexibility options
+- Naming conventions
+- Editor support details
+- Subagent support guidance