document-feature

Generate standardized feature documentation with Good Docs templates and Mermaid diagrams.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/amak07/acr-automotive --skill document-feature
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-feature
Source: https://github.com/amak07/acr-automotive/tree/main/.claude/skills/document-feature
Command: npx skills add https://github.com/amak07/acr-automotive --skill document-feature

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of consistent feature documentation using Good Docs templates, including architecture diagrams, API references, and how-to guides.

Core Features & Use Cases

  • Template-driven Docs: Generates Feature.md with sections like Overview, Architecture, API, How-To.
  • Code Examples: Pulls real examples from the codebase.
  • Technical Decisions Links: References related ADRs.
  • Use Case: Document the public search feature with links to architecture.

Quick Start

Create docs/features/search.md from the feature code.

Frequently Asked Questions about document-feature

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

FAQPage Schema
How do I generate standardized feature documentation with templates?

Feature documentation generation applies Good Docs templates to create consistent Markdown files. The Skill generates a structured feature doc at /docs/features/[feature-name].md with Overview, Architecture, API Reference, How-To Guides, Technical Decisions, Testing sections, Mermaid diagrams, and real code samples pulled from your repository.

Can I include architecture diagrams and code examples in my feature docs?

Yes. The Skill embeds Mermaid diagrams for architecture visualization and automatically extracts real code examples from your codebase into the generated documentation, eliminating manual code copying and keeping examples synchronized with your implementation.

What sections does a generated feature document include?

Generated feature documentation includes Overview, Architecture, API Reference, How-To Guides, Technical Decisions with ADR links, Testing guidance, and Related Documentation sections, all formatted as Markdown with diagrams and code samples for completeness.

Do I need existing ADRs to document features this way?

ADRs are optional but recommended. The Skill links to related Architecture Decision Records in the Technical Decisions section, helping readers understand the rationale behind feature design choices without requiring pre-existing documentation.

What's the best way to keep feature documentation synchronized with code changes?

Template-driven documentation generation ensures consistency across features. By pulling code examples directly from your repository, the Skill reduces drift between docs and implementation, though you regenerate docs when features significantly change.

Can I customize the template sections for my documentation style?

The Skill uses Good Docs templates as its standard structure: Overview, Architecture, API, How-To, ADRs, Testing, and Related Documentation. While the template sections are fixed, you can adapt content within each section post-generation to match your team's voice and requirements.