spec-document-format
Standard format for spec documents.
Informations de source
- Dépôt
- archibate/dotfiles-opencode
- Dernière activité de la source
- 24 février 2026 à 01:37
- Langue détectée de SKILL.md
- anglais
- Étoiles
- 108
- Forks
- 21
Options d'installation
Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.
Vérifiez les fichiers source
Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.
Affichage de SKILL.md
SKILL.md
Instructions source · Aperçu en lecture seule- 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.
Voir sur GitHub