Skip to main content

spec-document-format

Standard format for spec documents.

来源信息

仓库
archibate/dotfiles-opencode
最近来源活动
2026年2月24日 01:37
检测到的 SKILL.md 语言
英语
星标
108
Forks
21

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
spec-document-format
description
Standard format for spec documents.
## 📄 Specification Document Format All spec documents **MUST** follow this Markdown template. The file should be stored under `specs/` with a meaningful name, e.g., `specs/feature-authentication.md`. ```markdown # Specification: <Title> ## Metadata - **Version**: <semver, e.g., 1.0.0> - **Status**: Draft | Active | Realized | Regressible | Deprecated - **Author**: <agent or user> - **Created**: <YYYY-MM-DD> - **Last Updated**: <YYYY-MM-DD> ## Overview <Brief description of the feature or system> ## Requirements ### Functional Requirements - FR-1: <description> - FR-2: ... ### Non-functional Requirements - NFR-1: <architecture, performance, security, etc.> ## Test Steps <Step-by-step verification instructions. May be shell commands, manual actions, or both.> ## Acceptance Criteria <Conditions that must be satisfied for completion> ## Change Log | Date | Version | Description | Author | |------------|---------|-------------------|------------| | <date> | 1.0.0 | Initial draft | <author> | ``` ### 🎯 Document Quality When writting specification document: - Focus on **big-picture**. - DO NOT be too specific on implementation details. - Avoid ambiguous wording. - Include **edge cases** in test steps when appliable. - DO NOT hallucinate.
在 GitHub 查看