docs-codebase

Generate documentation templates for READMEs, ADRs, API docs, and changelogs.

73|16|Updated Nov 14, 2025

Search Tags:#documentation #adr #readme #api-docs #docs-as-code

Ready to run

npx skills add https://github.com/vasilyu1983/AI-Agents-public --skill docs-codebase

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-codebase
Source: https://github.com/vasilyu1983/AI-Agents-public/tree/main/frameworks/claude-code-kit/framework/skills/docs-codebase
Command: npx skills add https://github.com/vasilyu1983/AI-Agents-public --skill docs-codebase

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides execution-ready patterns for README, API docs, ADRs, changelogs, and docs-as-code workflows.

Core Features & Use Cases

Documentation templates: README, ADRs, API docs, changelogs.
Docs-as-code: Version-controlled documentation with CI/CD checks.
Guides: Style guides and documentation testing.

Quick Start

Generate an ADR and a README for a new module using the templates.

Frequently Asked Questions about docs-codebase

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

FAQPage Schema

How do I write a README that stays in sync with my codebase?▼

Version-control your README as Markdown alongside code, run CI/CD checks to validate sections match your actual API or architecture, and use docs-as-code patterns to keep documentation executable and current as your project evolves.

What is an ADR and why should I document architecture decisions?▼

An Architecture Decision Record (ADR) is a Markdown template that captures why you chose a technical approach, its trade-offs, and alternatives. ADRs make design rationale searchable, maintainable, and available to future team members without losing context.

Can I generate API documentation that stays compatible with OpenAPI 3.2?▼

Yes. Use Markdown-based API documentation templates that follow OpenAPI 3.2+ standards, version-control them with your code, and integrate automated validation into CI/CD to ensure your docs reflect your actual API schema.

How do I structure changelogs and contributing guides for maintainability?▼

Apply standardized Markdown templates for changelogs and contributing guides that work with automated changelog generation tools. Version-controlled templates ensure consistency, accessibility compliance (WCAG 2.2), and seamless integration with your documentation pipeline.

What's the best way to document code comments alongside technical writing?▼

Embed clear, purpose-driven code comments using patterns that extend your documentation style guides, ensuring inline explanations reinforce your broader README, ADR, and API docs without duplication or drift.

Does docs-as-code work with AI-assisted writing workflows?▼

Yes. Markdown-based docs-as-code patterns are compatible with AI writing assistance, version control, and CI/CD validation, allowing you to generate and refine documentation while maintaining consistency, accessibility, and traceability.