spec-document-format
Standard format for spec documents.
Datos de origen
- Repositorio
- archibate/dotfiles-opencode
- Última actividad en el origen
- 24 de febrero de 2026 a las 01:37
- Idioma detectado de SKILL.md
- inglés
- Estrellas
- 108
- Forks
- 21
Opciones de instalación
De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.
Revisa los archivos de origen
Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.
Mostrando SKILL.md
SKILL.md
Instrucciones de origen · Vista previa de solo lectura- 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.
Ver en GitHub