technical-specification_skill
- TypeScript
52
GitHub Stars
1
Bundled Files
2 months ago
Catalog Refreshed
4 months ago
First Indexed
Readme & install
Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.
Installation
Preview and clipboard use veilstrat where the catalogue uses aiagentskills.
npx veilstrat add skill secondsky/claude-skills --skill technical-specification- SKILL.md2.9 KB
Overview
This skill creates comprehensive technical specifications for software projects covering requirements, architecture, APIs, data models, testing, and rollout plans. It produces a reusable, measurable template you can apply to features, system designs, and architecture decision records. The output is structured to support stakeholder reviews and implementation planning.
How this skill works
The skill generates a full specification using a standardized template: metadata, executive summary, goals, functional and non-functional requirements, technical design, API examples, database schemas, implementation plan, testing strategy, risks, and success criteria. It fills in measurable acceptance criteria, performance targets, and rollout/rollback guidance based on provided project inputs. Diagrams, tables, and code snippets are included where applicable to make the design actionable.
When to use it
- Planning a new feature or service before engineering work begins
- Documenting system design for cross-team alignment or onboarding
- Creating architecture decision records (ADRs) for major choices
- Preparing implementation-ready API contracts and database schemas
- Defining testing, monitoring, and rollback plans prior to release
Best practices
- Include measurable acceptance criteria for every primary goal
- Specify non-functional requirements explicitly (performance, scalability, security)
- Provide API contracts and sample request/response payloads
- Add architecture diagrams and a clear implementation timeline
- Document risks, mitigations, and dependencies up front
- Request stakeholder review and sign-off before coding begins
Example use cases
- Drafting a spec for a new user-facing feature with API and DB changes
- Designing a scalable microservice with performance and availability targets
- Creating an ADR comparing authentication options and recommended approach
- Preparing test plans and success criteria for a major release
- Producing developer-facing docs that include schema and example API calls
FAQ
Focus the spec on the delta: list current behavior, desired change, impacted components, and migration plan. Keep scope small and measurable.
Can it include diagrams and code snippets?
Yes. The spec supports architecture diagrams, SQL schemas, and API request/response examples to make implementation explicit.
