engineering-design-docs

Draft engineering design documents with file plans, API contracts, and validation rules.

1|Updated Apr 17, 2026
One-click install
npx skills add https://github.com/alexgorbatchev/ai-registry --skill engineering-design-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: engineering-design-docs
Source: https://github.com/alexgorbatchev/ai-registry/tree/main/skills/engineering-design-docs
Command: npx skills add https://github.com/alexgorbatchev/ai-registry --skill engineering-design-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Engineering teams often convert vague requirements into unspecified guidance, causing ambiguity and costly rework. This skill helps produce implementation-ready design docs that define exact contracts, file layouts, and validation rules to guide engineering work.

Core Features & Use Cases

  • Generate exact file- and module-level designs, including API/schema/state contracts, file plans, and validation rules.
  • Provide a complete design-lifecycle workflow: created_on, last_modified, status, archiving, and traceability.
  • Use cases include drafting new designs for a feature, tightening an existing DESIGN.md, or converting a recommendation into a concrete build plan.

Quick Start

Create a new DESIGN.md at docs/internal/eng-designs/<topic>/DESIGN.md using the standard template and lifecycle frontmatter.

Frequently Asked Questions about engineering-design-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write an engineering design document for a new feature?

To write an engineering design document, draft an exact file plan, specify API contracts, and define validation rules. This process converts vague requirements into implementation-ready designs by detailing exact modules and interfaces for new subsystem builds.

What is the best way to tighten an existing DESIGN.md?

Tightening an existing DESIGN.md involves refining exact file layouts, updating API schema contracts, and enforcing validation rules. Apply this to existing feature topics to remove ambiguity, update lifecycle frontmatter like last_modified, and ensure implementation readiness.

What should be included in implementation-ready design docs?

Implementation-ready design docs must include lifecycle frontmatter (created_on, last_modified, status), an exact file plan, API contracts, and validation rules. This structure provides exact module-level specifications to guide engineering work without ambiguity.

When do I need to define API contracts and validation rules in a design doc?

You need to define API contracts and validation rules when converting vague requirements into implementation-ready designs. Specifying exact interfaces and validation logic prevents ambiguity and costly rework during the actual engineering implementation.

Can I use this to convert a recommendation into a concrete build plan?

Yes, you can convert a recommendation into a concrete build plan by applying it to a feature or subsystem topic. The process produces an exact engineering design document with specified files, modules, and interfaces ready for implementation.