Can I use this for API design?

Yes, it is ideal for API design as it encourages defining schemas, field definitions, and behavior end-to-end including error conditions before coding begins.

How does this skill help with project tracking?

It mandates a 'Current Status' section that evolves from an interview phase (listing open questions) to an implementation phase (using checklists and updates) to keep developers and reviewers aligned.

What is the difference between a Spec and a Documentation file?

Specs are implementation-focused 'single sources of truth' for designers and developers containing full schemas and rationale, while documentation files are brevity-focused usage guides for end-users.

What is the 'Self-Containment Principle'?

It means the specification should include every design detail, such as SQL DDL, field-level tables, and error handling logic, so a reader never needs to open another file to understand the complete design.

Technical Spec Writing Conventions

Name: Technical Spec Writing Conventions
Author: sorah

bysorah

•

学習とドキュメンテーション

Standardizes the creation of self-contained, implementation-ready technical specifications and design documents.

This skill provides a comprehensive framework for writing high-quality technical specifications that serve as the single source of truth for features. It enforces a clear distinction between internal design specs and user-facing documentation, ensuring that developers have all the necessary context—including schemas, architecture, and edge cases—without needing to hunt for information across multiple files. By standardizing the spec structure and tracking implementation progress via mandatory 'Current Status' sections, it streamlines the transition from initial design to final production code.

主な機能

01Distinguishes design specs from user-facing documentation layers

02Defines standard spec structures including Data Models and Architecture

03Provides guidelines for resolving TODOs and ambiguous language

0431 GitHub stars

05Includes a standardized format for tracking implementation status

06Enforces the 'Self-Containment Principle' for all design details

ユースケース

01Drafting initial feature specifications before starting development

02Tracking progress and open questions during the design-to-build phase

03Converting rough notes into implementation-ready design documents

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add sorah/config spec-conventions

For use in Claude.ai and ChatGPT