Technical Specification (Tech Spec) Generator | A Proven AI Prompt for Documentation for engineers | Engify.ai
Prompt Template
Copy the prompt template below
# Technical Specification (Tech Spec) Generator

## Problem Context

Technical specifications document what is currently implemented and live in production. Unlike design docs (which record decisions before implementation), tech specs describe the current state:
- **API Specifications**: Endpoints, request/response formats, authentication
- **Database Schema**: Tables, columns, indexes, relationships
- **System Architecture**: What's deployed, how it works, dependencies
- **Configuration**: Environment variables, settings, feature flags

Tech specs are essential for onboarding, debugging, and maintaining systems.

## Solution Pattern: Template Pattern

This prompt uses a structured template to create comprehensive technical specifications.

## Prompt Template

Act as a technical writer specializing in technical specifications. I need to create a Technical Specification (Tech Spec) for [system/component name].

Guide me through creating a comprehensive tech spec that documents what is currently live in production:

### 1. Overview
- **System/Component Name**: [Name]
- **Version**: [Current version]
- **Last Updated**: [Date]
- **Owner**: [Team/individual responsible]
- **Status**: [Active/Deprecated/Maintenance Mode]
- **Documentation Links**: [Related docs, runbooks, etc.]

### 2. System Architecture
- **High-Level Overview**: What does this system do?
- **Components**: List of main components/services
- **Dependencies**: External services, databases, APIs this system depends on
- **Deployment**: Where is this deployed? (environments, regions, infrastructure)
- **Architecture Diagram**: Describe the architecture (or reference diagram)

### 3. API Specifications
For each API endpoint:

#### Endpoint: [Name]
- **URL**: [Full endpoint path]
- **Method**: [GET/POST/PUT/DELETE/etc.]
- **Authentication**: [How to authenticate]
- **Request**:
  - Headers: [Required headers]
  - Query Parameters: [Parameters with types and descriptions]
  - Request Body: [Schema with example]
- **Response**:
  - Success Response (200): [Schema with example]
  - Error Responses: [Error codes, messages, examples]
- **Rate Limits**: [If applicable]
- **Deprecation**: [If deprecated, when and migration path]

### 4. Database Schema
- **Database Type**: [PostgreSQL, MongoDB, etc.]
- **Tables/Collections**: 
  - **Table Name**: [Name]
    - Columns/Fields: [Name, type, constraints, description]
    - Indexes: [Index name, columns, purpose]
    - Relationships: [Foreign keys, references]
    - Sample Data: [Example rows]
- **Migrations**: [How to run migrations, version history]

### 5. Data Models
- **Key Data Structures**: 
  - **Model Name**: [Name]
    - Fields: [Name, type, description, validation rules]
    - Example: [JSON example]
- **Data Flow**: [How data moves through the system]

### 6. Configuration
- **Environment Variables**: 
  - Variable name, description, default value, required
- **Feature Flags**: 
  - Flag name, description, current state, rollout plan
- **Settings**: [Configuration files, their structure, examples]

### 7. Authentication & Authorization
- **Authentication Method**: [OAuth, API keys, JWT, etc.]
- **Authorization Model**: [Role-based, permission-based, etc.]
- **Security Considerations**: [Encryption, secrets management, etc.]

### 8. Performance Characteristics
- **Latency**: [Expected response times]
- **Throughput**: [Requests per second, transactions per second]
- **Scalability**: [How it scales, bottlenecks]
- **Monitoring**: [Key metrics, dashboards, alerts]

### 9. Error Handling
- **Error Codes**: [List of error codes and meanings]
- **Error Response Format**: [Standard error response structure]
- **Retry Logic**: [When/how to retry]
- **Circuit Breakers**: [If applicable]

### 10. Testing
- **Test Coverage**: [Current test coverage]
- **Test Types**: [Unit, integration, E2E tests]
- **How to Run Tests**: [Commands, setup]
- **Test Data**: [How to get test data]

### 11. Deployment & Operations
- **Deployment Process**: [How to deploy]
- **Rollback Procedure**: [How to rollback]
- **Health Checks**: [Health check endpoints]
- **Runbooks**: [Links to operational runbooks]

### 12. Known Issues & Limitations
- **Known Bugs**: [List of known issues]
- **Limitations**: [What the system cannot do]
- **Technical Debt**: [Areas that need improvement]

### 13. Changelog
- **Recent Changes**: [Recent updates, versions]
- **Breaking Changes**: [If any, migration guides]

---

**Instructions:**
1. Focus on documenting what IS, not what SHOULD BE
2. Be precise and accurate - this is a reference document
3. Include code examples, schemas, and actual values where possible
4. Keep it up-to-date - tech specs should reflect current state
5. Use markdown formatting for readability
6. Include links to actual code, APIs, and dashboards where relevant

Once complete, format the tech spec as a comprehensive reference document that engineers can use to understand and work with the system.

---

*This prompt is part of the Engify.ai research-based prompt library. Tech specs document what's LIVE, unlike design docs which record decisions BEFORE implementation.*
Technical Specification (Tech Spec) Generator

Unlock Premium Features

Related Prompts

Try These Resources

Related Prompts

Use product strategy red prompt

Use api documentation generator prompt

Related Articles

Read about prompt engineering generation and sql

Master Prompt Engineering
