skills.rest
gonzoblasco
gonzoblascoCOMMUNITY
Explore all skills by this author →
𝕏@gonzoblascoGitHub

Documentation Expert

Generates and maintains README, CHANGELOG, AGENTS, and CONTRIBUTING documentation for software projects.

1|Updated Jul 20, 2026
Search Tags:#changelog#templates#documentation#markdown#readme#agents.md#repository hygiene
One-click install
npx skills add https://github.com/gonzoblasco/ai-developer-stack --skill documentation-expert-gonzoblasco
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Documentation Expert
Source: https://github.com/gonzoblasco/ai-developer-stack/tree/main/tools-automation/documentation-expert
Command: npx skills add https://github.com/gonzoblasco/ai-developer-stack --skill documentation-expert-gonzoblasco

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping project documentation accurate and consistent is tedious: READMEs go stale, changelogs get skipped, and AI agents lack the context files they need to work effectively. This Skill standardizes the creation and maintenance of professional documentation for both humans and AI agents. ## Core Features & Use Cases - Template-Based Generation: Creates README.md, CHANGELOG.md, AGENTS.md, and CONTRIBUTING.md from standardized templates following Keep a Changelog and Conventional Commits. - Agent Knowledge Base: Builds and audits a .knowledge/ directory (README, architecture, conventions) that serves as the single source of truth for AI agent context. - Project Analysis: Scans package.json, folder structure, and existing markdown to keep documentation aligned with the actual codebase. - Use Case: After finishing a feature, ask the Skill to update CHANGELOG.md under [Unreleased] and refresh .knowledge/architecture.md to reflect the new module you added. ## Quick Start Ask the assistant to initialize the project documentation by generating a README, AGENTS.md, and .knowledge/ base from the current codebase.

Frequently Asked Questions about Documentation Expert

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

FAQPage Schema
How do I generate a README for a new software project?▼

Provide the project repository and the Skill scans package.json and the folder structure, then generates a README from a template covering value proposition, tech stack, quick start, project structure, and a Mermaid architecture diagram.

How to maintain a CHANGELOG following Keep a Changelog?▼

The Skill derives changelog entries from task files or git history and organizes them under Keep a Changelog categories (Added, Changed, Fixed, Security) with SemVer versioning, placing new work under an Unreleased section.

What is an AGENTS.md file and why create one?▼

AGENTS.md documents operational rules, coding patterns, and workflow context specifically for AI agents working on a codebase. It ensures agents follow project conventions like naming standards, styling approaches, and testing requirements.

What is the .knowledge directory used for?▼

The .knowledge/ directory stores concise, technical context files (project overview, architecture decisions, code conventions) optimized for AI agents to parse. It acts as the single source of truth for agent-scoped context, avoiding duplication in /docs.

When should I not use automated documentation generation?▼

Avoid it when the task requires environment-specific validation or expert review, or when inputs and success criteria are unclear. The Skill documents only implemented behavior, so it will not invent unbuilt features.

Related Skills

Explore More Software Engineering Skills→
spencerbeggsspencerbeggs

/design-docs:user-docs-create-readme

Generate README.md files from project structure and package.json.

Community
Intermediate
syntropic137syntropic137

developer-experience

Audit developer experience against onboarding, inner loop, and error message guidelines.

Official
Advanced
arndvsarndvs

document

Write and audit technical documentation including READMEs, ADRs, changelogs, and Mermaid diagrams.

Community
Intermediate
soo-kate-yeonsoo-kate-yeon

moai-docs-generation

Generate API documentation from source code and OpenAPI specifications.

Community
Advanced