Token导航 LogoToken导航

Agent Skill · 研究检索

functional-specification-document(功能规范文件)

functional-specification-document 用于查找、检索和筛选相关信息,适合在 Codex、Claude、Cursor、Gemini CLI 中需要根据关键词、任务场景或来源线索快速定位候选结果时使用。可结合来源仓库、安装命令和原始 README 继续核验具体用法。安装前建议确认权限范围、维护状态,以及是否会触发联网、命令执行或文件读写。

functional-specification-document 是研究检索类 Agent Skill,可用宿主为 Codex、Claude、Cursor、Gemini CLI,通过GitHub 仓库获取,权限为需要联网;许可证信息还不明确,第三方扫描已通过,按安装量在研究检索类的 73,675 个 Skill 里排第 71,089。

总安装 196周安装 8GitHub Stars 1下载 63核验 2026-05-01

安装说明

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

安装方式

通过对话安装

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

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

命令行安装

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

skills.shnpx skills
npx skills add https://github.com/rahmat1929/skill-functional-specification-document --skill functional-specification-document

这个 Skill 是做什么的

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

functional-specification-document 用于查找、检索和筛选相关信息,适合在 Codex、Claude、Cursor、Gemini CLI 中根据关键词、任务场景或来源线索快速定位候选结果。它可结合来源仓库、安装命令和原始 README 继续核验具体用法。

安装前建议确认权限范围、维护状态,以及是否会触发联网、命令执行或文件读写。当前顶部介绍已提供,底部简介为空,原始 SKILL.md 摘录缺失。适用宿主包括 Codex、Claude、Cursor、Gemini CLI,接入前应确认版本、权限和运行环境要求。

来源仓库内路径:skills/functional-specification-document

上手步骤

4 步
  1. 1

    确认自己的宿主工具

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

  2. 2

    拿到安装命令

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

  3. 3

    安装后重启宿主

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

  4. 4

    按最小权限试用

    它需要需要联网,先在测试目录或测试账号里跑,确认没问题再放到正式项目。

常见问题

6 条

functional-specification-document 怎么安装?

在终端执行 npx skills add https://github.com/rahmat1929/skill-functional-specification-document --ski…。装完完全退出宿主工具再打开,让它重新扫描本地 Skill。

functional-specification-document 支持哪些 AI 工具?

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

functional-specification-document 需要什么权限?

权限级别是需要联网。该 Skill 可能需要联网访问来源站点、仓库或外部 API;具体网络访问范围需要结合源码和 README 复核。

functional-specification-document 是免费的吗?

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

functional-specification-document 用的人多吗?

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

functional-specification-document 安全吗?

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

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

值得选的地方

  • 同时适配 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调用外部服务未明确有提醒
functional-specification-document

功能规范文件 · 本页

1961需要联网未明确通过

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

SKILL.md 原文

Requirements & Functional Specification Document Generator

This skill produces structured Business Requirements Documents (BRDs) and implementation-ready Functional Specification Documents (FSDs). A BRD defines the business problem, goals, stakeholders, and high-level business rules. An FSD bridges the gap between what stakeholders want and what engineers need to build. It answers "what does the system do and how should it behave" without dictating internal architecture.

Content Rules

These rules govern every document this skill produces. Follow them strictly:

  • Distinguish Document Types — Know whether you are writing a BRD or an FSD. The BRD focuses on business priorities (the "why" and "what"), stricly avoiding technical constraints and implementation details. The FSD focuses on system behavior (the "how it behaves") translating those constraints to actionable scopes that developers understand.
  • NO CODE SAMPLES — Provide only explanations, conceptual descriptions, and structured information. Never include source code, pseudo-code, or implementation snippets.
  • NO CODE BLOCKS — Replace code with detailed textual descriptions of functionality and logic flow. The only permitted fenced blocks are Mermaid diagrams.
  • "What" and "why", not "how" — Use clear, developer-friendly language that focuses on system behavior and business rationale, not implementation mechanics.
  • Architectural understanding first — Prioritize system relationships, module interactions, and data flow over technical details.
  • Mermaid exclusively for visuals — Use Mermaid format for all diagrams: flowcharts, sequence diagrams, state diagrams, entity relationships, and architecture overviews. No ASCII art, no plaintext diagrams, no embedded images.
  • Exclude API & Database — The FSD does not cover API endpoint specifications or database schema design. Those belong in separate API Specification and Database Design documents respectively. The FSD references them but does not define them.

When to use this skill

  • A user wants to define the business goals and high-level requirements for an initiative (BRD)
  • A user wants to create a functional specification for a new product, feature, or system (FSD)
  • A user has a PRD, project brief, or set of requirements and needs them turned into a detailed BRD or FSD
  • A user asks to "spec out" or "write up" how something should work or what it should achieve
  • A user needs to document business goals, functional requirements, use cases, or acceptance criteria

Workflow

Phase 1: Gather Context

Before writing anything, understand what you're specifying. There are two paths depending on what the user provides:

Path A — User provides a source document (PRD, brief, requirements list, etc.): Read the document thoroughly. Extract the core requirements, identify gaps, and list clarifying questions. Present the questions to the user before proceeding. Don't guess at ambiguous requirements — ask.

Path B — No source document (interactive interview): Walk through these questions to build a mental model of the system:

  1. What is the product/feature? (one-sentence elevator pitch)
  2. Who are the users? (roles, personas, access levels)
  3. What are the core workflows? (the 3-5 things users will actually do)
  4. What external systems does this interact with? (third-party services, other internal modules)
  5. Are there constraints? (regulatory, platform, timeline, tech stack)
  6. What does success look like? (KPIs, acceptance criteria)

Don't ask all questions at once — use the first couple of answers to tailor follow-ups. The goal is to get enough information to write a solid first draft, not to exhaustively document everything upfront.

Phase 2: Write the Document

Determine if the user needs a BRD (business focus) or an FSD (system behavior focus). Read references/brd-template.md (for BRDs) or references/fsd-template.md (for FSDs) for the full document template and section-by-section guidance. Follow that template structure, but adapt it to the project — skip sections that genuinely don't apply and expand sections that need more depth.

Key principles while writing:

  • Be specific. "The system should be fast" is not a requirement. "Search results return within 200ms for up to 10,000 records" is.
  • Use consistent language. "SHALL" = mandatory, "SHOULD" = recommended, "MAY" = optional. Define this in the Document Conventions section and stick to it.
  • Every feature gets acceptance criteria. If you can't write a test for it, the requirement isn't clear enough.
  • Describe behavior, not implementation. State what the system does and why, never how it does it internally.
  • Assign priority to each requirement. Use MoSCoW: Must / Should / Could / Won't. This prevents scope creep and helps teams negotiate tradeoffs.
  • Number every requirement. Use a hierarchical ID scheme (e.g., FR-3.2.1) so requirements are traceable from spec to test to implementation.
  • Use Mermaid for all diagrams. State machines, user flows, system context, sequence diagrams — all in Mermaid format.

Phase 3: Output

Save the document as a Markdown file. Use the naming convention: BRD-[Project-Name].md or FSD-[Project-Name].md.

After generating the document, run the validation script to check structural completeness. The script validates required sections, requirement ID format, acceptance criteria presence, MoSCoW labels, Mermaid diagram presence, and flags any code blocks that shouldn't be there.

If validation reports issues, fix them before presenting the final document to the user. Show the user the validation summary alongside the finished document so they know it's been checked.

Phase 4: Review & Iterate

Present the draft to the user. Highlight:

  • Sections where you made assumptions (flag these explicitly)
  • Areas that need more detail from stakeholders
  • Requirements you marked as "Could" or "Won't" that the user might want to reconsider

Incorporate feedback and regenerate. Each revision should re-run validation.

Document Structure Summary

Business Requirements Document (BRD)

The BRD follows this top-level structure (see references/brd-template.md for details):

  1. Executive Summary — Purpose, background, and problem statement
  2. Business Goals & Objectives — Project goals and success metrics (KPIs)
  3. Project Scope — In scope and out of scope
  4. Stakeholders — Roles, influence, and responsibilities
  5. Business Requirements — High-level requirements mapped to MoSCoW priorities and business rules
  6. Assumptions, Constraints & Dependencies
  7. Glossary of Terms

Functional Specification Document (FSD)

The FSD follows this top-level structure (see references/fsd-template.md for details):

  1. Introduction — Purpose, scope, definitions, references, conventions
  2. Product Overview — Context, high-level functions, users, environment, constraints, assumptions
  3. Functional Requirements — Feature breakdown with IDs, descriptions, acceptance criteria, priority, business rules; use cases with main/alternative/exception flows
  4. User Interface Requirements — Screen descriptions, interaction behavior, navigation, accessibility
  5. Non-Functional Requirements — Performance, security, reliability, scalability, maintainability, accessibility
  6. System Behavior & Error Handling — State transitions (Mermaid), error matrix, edge cases
  7. Approval & Sign-Off — Stakeholder table, revision history
  8. Appendices — Mermaid diagrams, supplementary material

Output Quality Checklist

Before delivering the final FSD, mentally verify:

  • Every requirement has a unique ID and priority (MoSCoW)
  • (FSD only) Every feature has testable acceptance criteria
  • (FSD only) Use cases cover main flow + at least one alternative/error flow
  • (FSD only) Error handling is specified for user-facing operations
  • (FSD only) Non-functional requirements have measurable targets
  • No section is left as a placeholder or TODO
  • Cross-references between sections are consistent
  • All diagrams use Mermaid format (no code blocks, no ASCII art)
  • No code samples or code blocks appear anywhere in the document
  • No API endpoint definitions or database schemas are included
  • The document serves its audience correctly (BRD for business stakeholders, FSD for developers/QA).

平台分布

Codex

36.92%
按下载量换算23

Claude

29.54%
按下载量换算19

Cursor

16.59%
按下载量换算10

Gemini CLI

9.59%
按下载量换算6

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API;具体网络访问范围需要结合源码和 README 复核。

安装前确认

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

继续浏览同类 Skills