agents-md-updater

Synchronize AGENTS.md documentation with code changes using structured checklists.

1|Updated Dec 1, 2016
One-click install
npx skills add https://github.com/aaron-vaz/dotfiles --skill agents-md-updater
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: agents-md-updater
Source: https://github.com/aaron-vaz/dotfiles/tree/main/opencode/.opencode/skills/agents-md-updater
Command: npx skills add https://github.com/aaron-vaz/dotfiles --skill agents-md-updater

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that project documentation, specifically AGENTS.md files, remains up-to-date with code changes, preventing outdated or inaccurate information.

Core Features & Use Cases

  • Documentation Audit: Helps identify which sections of AGENTS.md need updating based on code modifications.
  • Structured Updates: Provides clear guidelines on what to update for different types of code changes (e.g., new modules, API changes).
  • Use Case: After adding a new build command to your project, use this Skill to quickly check and update the 'Build commands' section in your AGENTS.md file.

Quick Start

Use the agents-md-updater skill to check documentation after implementing a new feature.

Frequently Asked Questions about agents-md-updater

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

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

To keep project documentation in sync with code changes, you can use a structured checklist approach to audit files like AGENTS.md. This involves identifying outdated sections after architectural modifications or new build commands and applying style rules for concise updates.

What is the best way to update AGENTS.md files after modifying architecture?

The best way to update AGENTS.md files after architectural modifications is to follow a structured checklist tailored for documentation updates. This ensures you accurately capture new build commands, updated code patterns, and architectural changes with actionable guidelines.

When do I need to audit my project documentation?

You need to audit your project documentation when implementing new features, adding new build commands, or making architectural modifications. Auditing at these points prevents outdated information and ensures your AGENTS.md files reflect current code patterns.

Does this documentation sync approach work for new build commands?

Yes, this documentation sync approach works for new build commands by providing clear guidelines on what to update. It helps you quickly check and modify the relevant sections in your AGENTS.md file to reflect the new commands.

What style rules should I follow for concise, actionable documentation?

For concise, actionable documentation, you should follow style rules that require structured updates based on code modifications. The focus is on keeping information accurate and synchronized with architectural changes, new modules, and API updates.