spec-writer
installsforks
How to install spec-writer?
magebyte-zero/spec-superflow/spec-writer
$npx -y skills add MageByte-Zero/spec-superflow --skill spec-writerCreate or refine spec-superflow planning artifacts. Invoke when the change is understood well enough to write proposal.md, specs/, design.md, and tasks.md.
SKILL.md
| 1 | # Spec Writer |
| 2 | |
| 3 | Create or refine planning artifacts when the change has moved beyond exploration. |
| 4 | |
| 5 | ## Required Inputs |
| 6 | |
| 7 | Read `.spec-superflow.yaml` (especially `dp_0_decisions`, `dp_0_confirmed`) and any existing planning artifacts. If `dp_0_confirmed` is not `true`, stop and route back to `workflow-start` for DP-0. |
| 8 | |
| 9 | ## Config Check |
| 10 | |
| 11 | Run: `npx --yes --package spec-superflow@0.11.0 ssf runtime config --get artifacts.order` — generate in configured order (default: proposal → specs → design → tasks). Run with `artifacts.skip` — skip any listed artifacts. |
| 12 | |
| 13 | ## Artifact Roles |
| 14 | |
| 15 | - `proposal.md`: why and scope |
| 16 | - `specs/`: required behavior (testable) |
| 17 | - `design.md`: architecture decisions and trade-offs (not line-by-line) |
| 18 | - `tasks.md`: dependency-aware implementation steps |
| 19 | |
| 20 | ## Working Rules |
| 21 | |
| 22 | **Honor DP-0**: Read `dp_0_decisions`, respect confirmed constraints, don't silently expand scope. Pause on unconfirmed decisions. |
| 23 | |
| 24 | ### proposal.md |
| 25 | Must state: problem, what changes, capabilities affected, impact areas. |
| 26 | |
| 27 | ### specs/ |
| 28 | Every requirement must be testable. Use SHALL or MUST. Every requirement must have at least one `#### Scenario:` with WHEN/THEN. Group under ADDED/MODIFIED/REMOVED Requirements headers. |
| 29 | |
| 30 | ### design.md |
| 31 | Must have: Context (current state, constraints, stakeholders), Goals, Decisions (Choice + Rationale + Alternatives considered), Risks And Trade-Offs. |
| 32 | |
| 33 | ### tasks.md |
| 34 | Must include: |
| 35 | - **File Structure**: all files with one-sentence responsibility (Create/Modify) |
| 36 | - **Interfaces**: cross-batch Consumes/Produces with exact types |
| 37 | - **Per-task**: exact file paths, expanded TDD phases (5 steps), Interfaces block |
| 38 | - **Granularity**: each step 2-5 min, atomic |
| 39 | - **Zero placeholders**: no TBD, TODO, "figure out", "add appropriate" |
| 40 | - **Dependency ordering**: depends only on prior tasks, explicit "Depends on: Batch N" |
| 41 | |
| 42 | ## Artifact Generation |
| 43 | |
| 44 | Generate one at a time. Confirm each before next. This prevents scope drift — if proposal has errors, downstream artifacts are wrong. |
| 45 | |
| 46 | 1. `proposal.md` → present summary → wait for confirm |
| 47 | 2. `specs/` → present requirement list → wait for confirm |
| 48 | 3. `design.md` → present key decisions → wait for confirm |
| 49 | 4. `tasks.md` → present batch breakdown → wait for confirm |
| 50 | |
| 51 | ## Validation Checklist |
| 52 | |
| 53 | ### proposal.md |
| 54 | - `## Why` > 50 chars, `## What Changes`, `## Scope` (In/Out), `## Impact`, `## Capabilities`, no TBD/TODO |
| 55 | |
| 56 | ### specs/ |
| 57 | - SHALL/MUST for required behavior, `#### Scenario:` with WHEN/THEN per requirement, grouped under delta headers, no contradictions |
| 58 | |
| 59 | ### design.md |
| 60 | - `## Context`, `## Goals`, `## Decisions` (≥1, with Choice+Rationale+Alternatives), `## Risks And Trade-Offs` |
| 61 | |
| 62 | ### tasks.md |
| 63 | - `## File Structure`, `## Interfaces`, numbered tasks, exact file paths, TDD phases, ≤5 min steps, no placeholders, every requirement mapped, explicit dependencies |
| 64 | |
| 65 | **If any artifact fails validation, fix before handing off to contract-builder.** |
| 66 | |
| 67 | ## DP-2: Artifact Review Gate |
| 68 | |
| 69 | Present summary of all 4 artifacts (2-3 sentences each). Ask user for adjustments. After approval: |
| 70 | ```bash |
| 71 | npx --yes --package spec-superflow@0.11.0 ssf state set <change-dir> dp_2_result "approved: <summary>" |
| 72 | npx --yes --package spec-superflow@0.11.0 ssf state set <change-dir> dp_2_timestamp $(date -u +%Y-%m-%dT%H:%M:%SZ) |
| 73 | ``` |
| 74 | |
| 75 | ## Handoff Rule |
| 76 | |
| 77 | Do not start implementation after writing planning artifacts. Once stable, validated, and DP-2 is recorded, hand off to `contract-builder`. |
| 78 | |
| 79 | ## Exception Handling |
| 80 | |
| 81 | - **Parse failures**: Report specific file/error; don't generate from corrupted templates |
| 82 | - **Missing templates**: Fall back to artifact structure defined in this skill |
| 83 | - **User interruption**: Artifacts on disk are the recovery checkpoint; resume from first missing/incomplete one |
| 84 | - **Validation failure**: Fix before handoff — do not hand off broken artifacts |
People who liked this also viewed
6 picksType
- grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026
- lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026
- lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026
- docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026
- edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026
- lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026
