writing-design-docs

Generate feature and architecture design docs in Purpose/Behavior/Verify format.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/anthony-fdez/claude-skills --skill writing-design-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-design-docs
Source: https://github.com/anthony-fdez/claude-skills/tree/main/.claude/skills/writing-design-docs
Command: npx skills add https://github.com/anthony-fdez/claude-skills --skill writing-design-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that features and systems are well-documented, making them easier to understand, maintain, and scale by preventing knowledge silos and ensuring documentation stays in sync with code changes.

Core Features & Use Cases

  • Standardized Documentation: Creates design docs using the Purpose/Behavior/Verify structure for features and architecture.
  • Documentation Sync: Enforces updating documentation in the same PR as related code changes.
  • Use Case: When you implement a new user authentication flow, this Skill helps you write a clear design doc detailing its purpose, expected behavior, and verification steps, ensuring the documentation is updated alongside the code.

Quick Start

Write a design doc for the new user authentication flow.

Frequently Asked Questions about writing-design-docs

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

FAQPage Schema
How do I write design documentation for a new software feature?

To write design documentation for a new software feature, generate structured docs using a Purpose/Behavior/Verify format. This ensures features and systems are well-documented by detailing their purpose, expected behavior, and verification steps.

How do I keep technical documentation in sync with code changes?

Keep technical documentation in sync by enforcing documentation updates within the same pull request as related code modifications. This prevents knowledge silos and ensures docs stay current with evolving architecture.

What is the Purpose/Behavior/Verify format for architecture documentation?

The Purpose/Behavior/Verify format for architecture documentation is a structured approach that clearly defines a system's purpose, outlines its expected behavior, and details the steps to verify functionality, making systems easier to maintain and scale.

Where should I store feature documentation and architecture documentation?

Store feature documentation in the `docs/features/` directory and architecture documentation in the `docs/architecture/` directory. This standardized placement prevents knowledge silos and organizes system documentation effectively.

Do I need any specific dependencies to generate feature documentation?

You do not need any specific dependencies to generate feature documentation. The Skill operates independently to create structured design docs and enforce documentation synchronization within your pull requests.

When should I create design docs for my codebase?

Create design docs for your codebase when implementing new features or systems to prevent knowledge silos. Generating documentation during the development process ensures systems are easier to understand, maintain, and scale over time.