mcpField
T
technical-specification

technical-specification

github.com/aj-geddesDevelopment373806 installsUpdated 34w ago
Repository

About technical-specification

A skill for writing technical specifications that define requirements, architecture, implementation details, and acceptance criteria. It supports product and engineering teams creating feature specs, design records, API definitions, and related project documents.

Key features

  1. 01Requirements and acceptance criteria
  2. 02Architecture and implementation details
  3. 03API contracts and data models
  4. 04Database schema documentation
  5. 05Security, performance, and risk guidance

Use cases

  1. 01Drafting a feature specification
  2. 02Recording an architecture decision
  3. 03Defining API or database designs
  4. 04Preparing a technical proposal or RFC

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill technical-specification

After installing, type/technical-specificationin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
api-data-models.md
authentication-endpoints.md
database-schema.md
functional-requirements.md
non-functional-requirements.md
phase-1-core-authentication.md
rate-limiting.md
templates/
doc-template.md

Details

From the project README

Technical Specification

Table of Contents

Overview

Create comprehensive technical specifications that define system requirements, architecture, implementation details, and acceptance criteria for software projects.

When to Use

  • Feature specifications
  • System design documents
  • Requirements documentation (PRD)
  • Architecture decision records (ADR)
  • Technical proposals
  • RFC (Request for Comments)
  • API design specs
  • Database schema designs

Quick Start

Minimal working example:

# Technical Specification: [Feature Name]

**Document Status:** Draft | Review | Approved | Implemented
**Version:** 1.0
**Author:** John Doe
**Date:** 2025-01-15
**Reviewers:** Jane Smith, Bob Johnson
**Last Updated:** 2025-01-15

## Executive Summary

Brief 2-3 sentence overview of what this spec covers and why it's being built.

**Problem:** What problem are we solving?
**Solution:** High-level description of the solution
**Impact:** Expected business/user impact

---

## 1. Background

### Context

Provide background on why this feature is needed:

// ... (see reference guides for full implementation)

Reference Guides

Detailed implementations in the references/ directory:

GuideContents
Functional RequirementsFunctional Requirements
Non-Functional RequirementsNon-Functional Requirements
Database SchemaDatabase Schema
API Data ModelsAPI Data Models
Authentication EndpointsAuthentication Endpoints
Rate LimitingRate Limiting
Phase 1: Core AuthenticationPhase 1: Core Authentication (Week 1-2), Phase 2: Email Verification (Week 3), Phase 3: Social Login (Week 4), Phase 4: Security Features (Week 5) (+1 more)

Best Practices

✅ DO
  • Include acceptance criteria for each requirement
  • Provide architecture diagrams
  • Document API contracts
  • Specify performance requirements
  • List risks and mitigations
  • Include implementation timeline
  • Add success metrics
  • Document security considerations
  • Version your specs
  • Get stakeholder review
❌ DON'T
  • Be vague about requirements
  • Skip non-functional requirements
  • Forget about security
  • Ignore alternatives
  • Skip testing strategy
  • Forget monitoring/observability
  • Leave questions unanswered

Comments

Markdown supported