component-docs

Generate component documentation from git changes using templates.

Updated Nov 4, 2025
One-click install
npx skills add https://github.com/putto11262002/jimmodel --skill component-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: component-docs
Source: https://github.com/putto11262002/jimmodel/tree/main/.claude/skills/component-docs
Command: npx skills add https://github.com/putto11262002/jimmodel --skill component-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

Developers often struggle to keep documentation updated with code changes, leading to stale or missing docs. This skill automates the process by leveraging Git history to generate or update component documentation, ensuring accuracy and consistency.

Core Features & Use Cases

  • Git-Driven Discovery: Automatically explores Git changes to identify implemented details (files, libraries, config).
  • Template-Based Documentation: Creates or updates docs using consistent templates, ensuring all necessary sections are covered.
  • Use Case: After implementing a new authentication system, trigger this skill to automatically generate a comprehensive authentication.md document in docs/components/, detailing files, technologies, configuration, and how it works.

Quick Start

Document the new authentication system I just implemented.

Frequently Asked Questions about component-docs

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

FAQPage Schema
How do I automatically generate component documentation from Git changes?

Generate component documentation by analyzing Git changes to identify implemented files, technologies, and configuration details. The skill explores your Git history, applies a consistent template, and produces up-to-date docs in docs/components/ without manual effort.

Can I use this to document components I recently implemented?

Yes. After implementing new features or components, trigger this skill to automatically discover what you built—files, libraries, configs—and generate comprehensive documentation in your docs/components/ folder, keeping docs in sync with code.

What does a Git-driven discovery workflow mean for documentation?

Git-driven discovery means the skill reads your commit history and changed files to extract implementation details automatically, then validates and renders them into structured documentation. This ensures docs reflect what was actually built, not guesses.

How do I keep component docs updated when code changes?

Run this skill after making code changes to re-analyze Git history, extract updated implementation details, and regenerate documentation using the same template. This workflow ensures docs stay current without manual rewrites.

Does this work with Next.js projects?

Yes. The skill is designed to work with Next.js projects and other codebases using Git version control. It extracts files, technologies, and configurations from your Git history to document components consistently.