Token导航 LogoToken导航

Agent Skill · 研究检索

spec-writing(规范编写)

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

spec-writing 是研究检索类 Agent Skill,可用宿主为 Codex、Claude、Cursor、Gemini CLI,通过GitHub 仓库获取,权限为操作浏览器;许可证信息还不明确,第三方扫描已通过,按安装量在研究检索类的 73,675 个 Skill 里排第 46,747。

总安装 766周安装 31GitHub Stars 1下载 241核验 2026-05-01

安装说明

本站只整理中文说明,不托管安装包,也不代用户安装。
GitHub
许可证
unknown

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:spec-writing(规范编写)
来源仓库:https://github.com/pixel-process-ug/superkit-agents
仓库路径:skills/spec-writing
安装命令:
npx skills add https://github.com/pixel-process-ug/superkit-agents --skill spec-writing
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

skills.shnpx skills
npx skills add https://github.com/pixel-process-ug/superkit-agents --skill spec-writing

这个 Skill 是做什么的

研究检索类 Skill 主要解决「找资料、核对事实、把来源整理清楚」的问题,通常会让助手先检索再总结。

spec-writing 用于辅助文档、README 和内容稿件的整理与改写,适合提炼结构和统一术语。适用于文档编写和内容优化的辅助工作,可检查链接和补齐章节。使用时应保留项目已有事实和路径,不要写成确定结论。涉及对外文案时需要控制语气,避免过度营销或夸大能力。

适用宿主包括 Codex、Claude、Cursor、Gemini CLI,接入前应确认版本、权限和运行环境要求。

来源仓库内路径:skills/spec-writing

上手步骤

4 步
  1. 1

    确认自己的宿主工具

    公开资料标注支持 Codex、Claude、Cursor、Gemini CLI;先确认自己用的是其中之一,再按对应工具的 Skills 目录放置。

  2. 2

    拿到安装命令

    可以直接复制的命令是 npx skills add https://github.com/pixel-process-ug/superkit-agents --skill spec-…;命令里的占位符换成自己的路径或密钥再执行。

  3. 3

    安装后重启宿主

    命令执行完要完全退出宿主工具再打开,让新装的 Skill 被重新扫描到,否则列表里可能看不到。

  4. 4

    按最小权限试用

    它需要操作浏览器,先在测试目录或测试账号里跑,确认没问题再放到正式项目。

常见问题

6 条

spec-writing 怎么安装?

在终端执行 npx skills add https://github.com/pixel-process-ug/superkit-agents --skill spec-writing。装完完全退出宿主工具再打开,让它重新扫描本地 Skill。

spec-writing 支持哪些 AI 工具?

公开资料标注支持 Codex、Claude、Cursor、Gemini CLI。其他工具只要能读取本地 Skill 目录,一般也能手动放进去,但要自己确认触发方式是否一致。

spec-writing 需要什么权限?

权限级别是操作浏览器。该 Skill 可能涉及浏览器控制能力,使用时可能读取或操作网页内容,需要在受控环境中确认权限边界。

spec-writing 是免费的吗?

公开资料没有标注明确许可证,收费和商用限制都无法确认。正式使用前请到来源仓库核对授权说明。

spec-writing 用的人多吗?

公开数据是累计安装 766 次,近一周安装 31 次,下载 241 次,GitHub 1 星。这些数字来自第三方目录统计,只能当作热度参考,不代表质量或安全性。

spec-writing 安全吗?

第三方扫描结果为通过,但这只覆盖已知的静态检查项,不能替代自己读一遍源码和安装命令。

值得选的地方和要先想清楚的地方

值得选的地方

  • 同时适配 4 种工具,换客户端不用重新找替代品。
  • 第三方扫描已通过,常见的高风险行为没有命中。

先想清楚的地方

  • 许可证没有明确标注,能不能商用、能不能再分发都不确定。
  • 第三方目录整理,版本更新和行为细节以来源仓库为准。

适不适合你

更适合

  • 已经在用 Codex,想直接扩展它能力的人。
  • 需要处理研究检索类任务、又不想每次都手写提示词的人。

不太适合

  • 需要明确授权才能用到公司项目里的场景。
  • 需要厂商级技术支持和 SLA 的生产系统。

研究检索类 Skill 对比

6 个同类
Skill总安装GitHub 星权限许可证扫描
find-skills

寻找技能 · Codex、Claude

31,199,81316,486操作浏览器MIT有提醒
self-improving-agent

自我改进 Agent · OpenClaw

16,464,0023,396接触敏感数据MIT-0通过
soultrace

灵魂追踪 · Codex、Claude

7,588,94412需要联网未明确有提醒
self-improving

自我完善 · OpenClaw

6,829,2841,046需要联网MIT-0通过
microsoft-foundry

微软代工厂 · Codex、Claude

6,614,144764调用外部服务未明确有提醒
spec-writing

规范编写 · 本页

7661操作浏览器未明确通过

按安装量取同分类前几名;数字来自第三方目录统计,只作热度参考,不代表质量结论。

SKILL.md 原文

Specification Writing

Overview

Specifications define WHAT the software should do, never HOW. This skill applies the Jobs to Be Done (JTBD) methodology to break requirements into properly scoped, testable specification files that drive autonomous implementation. Every spec produces Given/When/Then acceptance criteria free of implementation details.

This is a RIGID skill. Every phase, gate, and format rule must be followed exactly.

The Cardinal Rule

[HARD-GATE:SPEC] Specifications must NEVER contain implementation details.

ForbiddenAllowed
Code blocks or snippetsBehavioral descriptions
Variable names or function signaturesObservable outcomes
Technology choices ("use React", "use PostgreSQL")Capability requirements ("renders in browser", "persists data")
Algorithm suggestions ("use K-means clustering")Success criteria ("extracts 5-10 dominant colors")
Architecture patterns ("use MVC")User-facing behaviors
Library references ("use Zod for validation")Validation requirements ("rejects malformed input")

Why: Implementation-free specs preserve flexibility. The implementing agent can choose the best approach for the codebase, technology, and constraints — and change course without spec updates.

Phase 1: Jobs to Be Done (JTBD)

Identify the user's or system's jobs using this format:

When [situation], I want to [motivation], so I can [expected outcome].

Examples:

  • "When I upload an image, I want to extract its color palette, so I can use those colors in my design."
  • "When I receive an API request, I want to validate the payload, so I can reject malformed data before processing."

Gather jobs through discovery questions:

  1. Who is the user/actor?
  2. What situation triggers this need?
  3. What outcome do they want?
  4. What happens if they cannot accomplish this?

STOP after JTBD identification — present all jobs to the user for confirmation before breaking into topics.

Phase 2: Topics of Concern

Break each job into discrete topics. Apply the "One Sentence Without 'And'" test:

TestResultAction
"This spec covers color extraction."PASSSingle topic — one spec file
"This spec covers color extraction and palette rendering."FAILTwo topics — split into two spec files
"This spec covers user authentication and session management."FAILSplit into two specs
"This spec covers input validation for the registration form."PASSSingle topic — one spec file

Each topic becomes one specification file.

STOP after topic breakdown — confirm the list of spec files before writing them.

Phase 3: Write Specification Files

File naming convention: <int>-<descriptive-name>.md

specs/
├── 01-color-extraction.md
├── 02-palette-rendering.md
├── 03-export-formats.md
└── 04-color-accessibility.md

Specification File Template

# [Topic Name]

## Job to Be Done
When [situation], I want to [motivation], so I can [expected outcome].

## Acceptance Criteria

### [Criterion 1 Name]
- Given [precondition]
- When [action]
- Then [observable outcome]
- And [additional observable outcome]

### [Criterion 2 Name]
- Given [precondition]
- When [action]
- Then [observable outcome]

## Edge Cases
- [Describe boundary condition and expected behavior]
- [Describe error condition and expected behavior]

## Data Contracts
- Input: [Describe shape, constraints, valid ranges]
- Output: [Describe shape, guarantees, invariants]

## Non-Functional Requirements
- Performance: [measurable target, e.g., "responds within 200ms for 95th percentile"]
- Accessibility: [specific standard, e.g., "WCAG 2.1 AA"]
- Security: [specific requirement, e.g., "input sanitized against XSS"]

Acceptance Criteria Quality Rules

RuleGood ExampleBad Example
Observable behavioral outcome"Extracts 5-10 dominant colors from any image""Use K-means clustering with k=8"
Testable"Color data persists across sessions""Store in PostgreSQL JSONB column"
Specific and measurable"Palette changes appear within 500ms""Use WebSocket for real-time updates"
Independent (stands alone)"Palette renders when image loads""Implement with React useEffect hook"
Implementation-free"Passwords cannot be recovered from stored data""Use bcrypt with 12 salt rounds"

STOP after writing specs — run the audit checklist before proceeding to Phase 4.

Spec Audit Checklist

#CheckPass Criteria
1No implementation detailsZero code, function names, or tech choices
2One Sentence Without 'And' testEach spec covers exactly one topic
3All criteria are Given/When/ThenNo free-form prose criteria
4All criteria are testableEach can be verified by a test
5Edge cases documentedAt least 2 per spec
6Data contracts definedInput and output shapes specified
7Consistent naming<int>-<descriptive-name>.md format

Phase 4: Story Map Organization

Organize specs into a story map for release planning:

CAPABILITY 1    CAPABILITY 2    CAPABILITY 3    CAPABILITY 4
─────────────   ─────────────   ─────────────   ─────────────
basic upload    auto-extract    manual arrange  export PNG
bulk upload     palette gen     templates       export SVG
drag-drop       color names     grid layout     share link
                accessibility   animation       collaborate
  • Horizontal rows = candidate releases
  • Top row = minimum viable release
  • Each row adds capabilities across the board

SLC Release Criteria

For each horizontal slice, evaluate:

CriterionQuestionStandard
SimpleCan it ship fast with narrow scope?Weeks, not months
LovableWill people actually want to use it?Delightful, not just functional
CompleteDoes it fully accomplish a job?End-to-end, not half-done

[HARD-GATE] A release must satisfy ALL three. "Simple but incomplete" is not shippable. "Complete but not lovable" is not shippable.

STOP after story map — get user confirmation on release slicing before finalizing.

Phase 5: Specs Audit Mode

When auditing existing specs (rather than writing new ones):

  1. Read all spec files in specs/
  2. Check each against the Cardinal Rule (no code, no implementation details)
  3. Verify "One Sentence Without 'And'" test
  4. Ensure consistent naming convention
  5. Verify Given/When/Then format for all acceptance criteria
  6. Flag violations and auto-fix where possible

Deploy up to 100 parallel subagents via the Agent tool (with subagent_type="Explore") — one per spec file — for large spec sets.

Anti-Patterns / Common Mistakes

MistakeWhy It Is WrongWhat To Do Instead
Including code snippets in specsLocks implementation approachDescribe behavior, not mechanism
Naming technologies ("use Redis")Prevents better alternativesDescribe capability ("caches results")
Combining topics with "and"Spec too broad, hard to implement/testSplit into separate spec files
Vague acceptance criteria ("works well")Cannot write a test for itSpecific measurable outcome
Missing edge casesBugs in boundary conditionsDocument at least 2 edge cases per spec
Skipping data contractsInput/output ambiguityAlways define shapes and constraints
Writing specs after codeSpecs justify code instead of driving itSpecs come BEFORE implementation
Acceptance criteria that describe UI layoutImplementation detailDescribe what the user can accomplish

Anti-Rationalization Guards

  • [HARD-GATE] Do NOT include ANY implementation details — no code, no tech names, no architecture
  • [HARD-GATE] Do NOT skip the "One Sentence Without 'And'" test — split every compound topic
  • [HARD-GATE] Do NOT accept acceptance criteria that are not in Given/When/Then format
  • [HARD-GATE] Do NOT skip the audit checklist before finalizing specs
  • Do NOT skip edge cases — every spec needs at least 2
  • Do NOT skip data contracts — every spec needs input/output shapes
  • Do NOT write specs after implementation — specs drive code, not the reverse

Integration Points

SkillRelationship
autonomous-loopPlanning mode reads specs to identify implementation gaps
acceptance-testingTests are derived directly from spec acceptance criteria
reverse-engineering-specsGenerates specs from existing code (brownfield)
prd-generationPRD provides high-level requirements; specs detail them
planningPlans reference spec acceptance criteria for task definition
test-driven-developmentRed phase writes tests matching spec acceptance criteria
writing-skillsSkills can be specified using this methodology

Concrete Example: Complete Spec File

# Image Color Extraction

## Job to Be Done
When I upload an image to the design tool, I want to automatically extract
its dominant colors, so I can use those colors in my design palette.

## Acceptance Criteria

### Dominant Color Extraction
- Given an uploaded image in PNG, JPG, or WebP format
- When the extraction process completes
- Then 5-10 dominant colors are returned as hex values
- And colors are ordered by prominence (most dominant first)

### Transparent Image Handling
- Given an uploaded image with transparent regions
- When the extraction process completes
- Then transparent regions are excluded from color analysis
- And at least 3 dominant colors are still returned

### Processing Feedback
- Given an image upload has started
- When extraction is in progress
- Then the user sees a progress indicator
- And extraction completes within 3 seconds for images up to 10MB

## Edge Cases
- Single-color image: returns 1 color (not an error)
- Very large image (>50MB): returns an error with size limit message
- Corrupted image file: returns an error with clear message, no crash
- Animated GIF: extracts colors from the first frame only

## Data Contracts
- Input: Image file (PNG, JPG, WebP), max 50MB
- Output: Array of 1-10 hex color strings, ordered by prominence
- Error output: Error object with code and human-readable message

## Non-Functional Requirements
- Performance: <3s for images up to 10MB, <10s for images up to 50MB
- Accessibility: Color values include WCAG contrast ratio against white/black

Verification Gate

Before claiming specs are complete:

  1. VERIFY the Cardinal Rule — zero implementation details in any spec
  2. VERIFY every spec passes the "One Sentence Without 'And'" test
  3. VERIFY all acceptance criteria use Given/When/Then format
  4. VERIFY every spec has edge cases and data contracts
  5. VERIFY the story map has at least one complete SLC release slice
  6. VERIFY the user has confirmed the spec set

Skill Type

Rigid — The no-implementation-details rule, JTBD structure, Given/When/Then format, and audit checklist must be followed exactly. No elements may be skipped or adapted.

平台分布

Codex

34.83%
按下载量换算84

Claude

32.59%
按下载量换算79

Cursor

19.34%
按下载量换算47

Gemini CLI

10.63%
按下载量换算26

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

操作浏览器

该 Skill 可能涉及浏览器控制能力,使用时可能读取或操作网页内容,需要在受控环境中确认权限边界。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。目前只有一个公开来源,建议同时核对源仓库。

继续浏览同类 Skills