agent-documenter

Update README, API docs, changelogs, and .agent/ context after code changes.

4|Updated Mar 31, 2026
One-click install
npx skills add https://github.com/ryan-nguyen-01/agent-platform --skill agent-documenter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: agent-documenter
Source: https://github.com/ryan-nguyen-01/agent-platform/tree/main/.claude/Agents/agent-documenter
Command: npx skills add https://github.com/ryan-nguyen-01/agent-platform --skill agent-documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Giữ documentation luôn đồng bộ với code. Chạy SAU code review pass. Xử lý cả docs chính thức (README, API docs, changelogs) lẫn internal context (.agent/). Không viết tutorial — viết developer docs ngắn gọn, chính xác.

Core Features & Use Cases

  • Đảm bảo sự đồng bộ docs sau mỗi thay đổi mã nguồn.
  • Cập nhật các tài liệu chính thức (README, API docs, changelog) và context nội bộ (.agent/).
  • Hỗ trợ cập nhật nhanh các section bị ảnh hưởng mà không rewrite toàn bộ tài liệu.

Quick Start

Chạy agent-documenter ngay sau khi code review để cập nhật tài liệu và .agent/ context.

Frequently Asked Questions about agent-documenter

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

FAQPage Schema
How do I keep documentation in sync with code changes automatically?

Documentation synchronization is achieved by running the agent-documenter after code review passes. It updates impacted sections of README, API docs, changelogs, and internal .agent/ context to reflect new code changes.

Does this documentation sync tool update the entire README or only impacted sections?

This documentation tool updates only impacted sections rather than rewriting entire files. It targets affected parts of README, API docs, changelogs, and internal context, ensuring concise and accurate developer-facing updates.

How do I update internal agent context after modifying project source code?

Internal agent context updates automatically by compressing new code content into YAML format within .agent/context/modules. The automation runs after code changes to ensure internal context reflects the latest project state.

What is the best way to automate changelog and API docs updates after a code review?

Automating changelog and API docs updates is handled by running the agent-documenter post code review. It writes concise developer-facing documentation and compresses new context into YAML for internal use.

Can I use this to write developer tutorials from my codebase?

No, you cannot use this to write developer tutorials. The tool specifically writes concise, accurate developer documentation and internal context updates, explicitly excluding tutorial generation from its scope.

When should I run documentation synchronization in my development workflow?

Documentation synchronization should run immediately after code changes that affect documentation pass code review. This ensures both official docs and internal .agent/ contexts remain aligned with the codebase without manual intervention.