agentdocs

Analyze a codebase to scaffold seven agentdocs topic files and update CLAUDE.md.

Updated Feb 23, 2026

Search Tags:#documentation #codebase #scaffold #conventions #CLAUDE.md #topic-files #agentdocs

Ready to run

npx skills add https://github.com/schirrmacher/coding --skill agentdocs-schirrmacher

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: agentdocs
Source: https://github.com/schirrmacher/coding/tree/main/skills/agentdocs
Command: npx skills add https://github.com/schirrmacher/coding --skill agentdocs-schirrmacher

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scaffold a structured agentdocs/ documentation directory by deriving topic-specific conventions from the target project, reducing manual setup time and ensuring consistent documentation.

Core Features & Use Cases

Analyze the target codebase to identify key domains and generate seven topic files under agentdocs/ (project, workflow, layout, architecture, style, testing, this).
Update or create CLAUDE.md with a Conventions section linking to each topic file.
Provide a reusable documentation scaffold that guides agents through topic-specific rules and design principles.

Quick Start

Run the agent in the project root and invoke the /agentdocs trigger to generate the seven topic files and CLAUDE.md.

Frequently Asked Questions about agentdocs

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

FAQPage Schema

How do I automatically generate documentation files from my codebase?▼

You can automatically generate documentation files by running the agentdocs trigger in your project root. It inventories the codebase to scaffold a structured agentdocs directory with seven topic-specific files.

What is the best way to structure project conventions for AI agents?▼

Structuring project conventions for AI agents is best handled by generating topic files under agentdocs and updating CLAUDE.md. This creates a centralized Conventions section linking to detailed rules for project, workflow, layout, architecture, style, and testing.

How do I set up a CLAUDE.md file linked to topic-specific documentation?▼

To set up CLAUDE.md linked to topic-specific documentation, run the agentdocs trigger. It updates or creates CLAUDE.md with a Conventions section that links directly to each of the seven generated topic files.

Do I need any dependencies to scaffold an agentdocs directory in my project?▼

You do not need any dependencies to scaffold an agentdocs directory. The skill runs independently, reading the project root and codebase to write the seven topic files and CLAUDE.md without external requirements.

What files are generated when scaffolding documentation for a codebase?▼

Scaffolding documentation for a codebase generates seven topic files under the agentdocs directory: project, workflow, layout, architecture, style, testing, and this. It also updates CLAUDE.md to include a this.md template guiding writing.

Can I use agentdocs for an existing codebase or only for new projects?▼

You can use agentdocs for an existing codebase. The skill analyzes your current project root to derive topic-specific conventions and generate the documentation skeleton, making it suitable for both new and established repositories.