agentleFS
T-miracleT-miracle/codex-skills-zh/skills/planning/to-spec/SKILL.md

to-spec

Skill5 starsChanged 3 months agoMITView on GitHub

将当前对话综合为 spec 并发布到项目 issue tracker;不进行访谈,只整理已经讨论的内容。

194 other projects use a version of this, 4 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use setup-ts-deep-modules, to-questionnaire and 8 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • liufeng1976Skill

    setup-ts-deep-modules

    Wire dependency-cruiser into a TypeScript repo so each package is a deep module — implementation hidden in subfolders, reachable only through its entry-point files. User-invoked.

    Also in 43 projects that use this

  • AWSSkill

    to-questionnaire

    Turn a decision you can't fully answer into a questionnaire for someone else to fill in.

    Also in 90 projects that use this

  • RoentekSkill

    loop-me

    Grill me about specs for the workflows I want to build, within this workspace.

    Also in 49 projects that use this

  • AWSSkill

    wizard

    Generate an interactive bash wizard that walks a human through steps only they can perform. Use when provisioning infrastructure, setting up credentials or CI secrets, walking an unfamiliar third-party dashboard, or running a one-off migration or cutover. Don't invoke this for steps the agent can perform itself.

    Also in 116 projects that use this

  • ryotaroh180105Skill

    claude-handoff

    Hand the current conversation off to a fresh background agent that picks up the work immediately.

    Also in 39 projects that use this

  • LesaniSkill

    writing-beats

    Shape an article as a journey of beats, choose-your-own-adventure style. The user picks a starting beat from the raw material, you write only that beat, then offer options for where to pivot next, beat by beat, until the article reaches a natural end. Use when the user has raw material and wants to assemble it as a narrative rather than an argument.

    Also in 51 projects that use this

The file

Files
SKILL.md

本技能根据当前对话上下文和对代码库的理解生成一份规格文档(spec)。不要访谈用户:只综合你已经掌握的信息。

你应当已经获得议题跟踪器(issue tracker)和分诊标签词汇(triage label vocabulary);如果没有,提醒用户运行 /setup-matt-pocock-skills。

流程

  1. 如果尚未探索仓库,就先了解代码库的当前状态。在整份规格中使用项目领域词汇表(domain glossary)中的术语,并遵守所涉及区域的所有 ADR。
  2. 勾勒出将用于测试该功能的接缝(seams)。优先使用现有接缝而不是新接缝,并尽可能采用最高层接缝。如果确实需要新接缝,就在尽可能高的层级提出。代码库中的接缝越少越好:理想数量是一个。

向用户确认这些接缝是否符合其预期。

  1. 使用以下模板编写规格,然后发布到项目议题跟踪器。应用 ready-for-agent 分诊标签:无需进行其他分诊。
<spec-template>

Problem Statement

从用户视角描述用户面临的问题。

Solution

从用户视角描述问题的解决方案。

User Stories

一份很长的编号用户故事(user stories)列表。每个用户故事都应采用以下格式:

  1. As an <actor>, I want a <feature>, so that <benefit>
<user-story-example> 1. As a mobile bank customer, I want to see balance on my accounts, so that I can make better informed decisions about my spending </user-story-example>

用户故事列表应当极其详尽,并覆盖该功能的所有方面。

Implementation Decisions

列出已经做出的实现决策,可以包括:

  • 将要构建或修改的模块
  • 将要修改的模块接口
  • 开发者给出的技术澄清
  • 架构决策
  • 模式变更
  • API 契约(API contracts)
  • 具体交互

不要包含具体文件路径或代码片段。它们可能很快过时。

例外:如果原型生成的片段能够比文字更精确地表达某项决策(状态机、reducer、模式、类型形状),就在相关决策中内联该片段,并简要注明其来自原型。只保留承载决策的部分:不要放入可运行的演示,只保留重要内容。

Testing Decisions

列出已经做出的测试决策,包括:

  • 对良好测试的说明(只测试外部行为,不测试实现细节)
  • 将要测试哪些模块
  • 可供这些测试借鉴的先例(即代码库中类似类型的测试)

Out of Scope

描述本规格范围之外的事项。

Further Notes

关于该功能的其他说明。

</spec-template>

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.