← ClaudeAtlas

ami-docs-updaterlisted

Identifies if codebase documentation exists and updates it to reflect code changes before publishing a PR.
AnaCataVC/amiga-ia · ★ 0 · AI & Automation · score 61
Install: claude install-skill AnaCataVC/amiga-ia
# Skill: Push Docs Updater When invoked, act as a Technical Writer to ensure all repository documentation is synchronized with the new code changes. ## Workflow 1. **Locate Documentation:** - Look for standard documentation files (e.g., `README.md`, `docs/`, `.md` files). - Read the files to understand the current documented state. 2. **Analyze Changes & Update:** - Review the diffs of the current PR. - If the PR introduces new features, changes API endpoints, alters configuration requirements, or modifies existing behavior, find the exact place in the documentation where this is described. - **CRITICAL:** Before editing any documentation files, you MUST present a summary or diff of the proposed documentation updates in the chat and ask the user for explicit approval. - Once approved, edit the documentation files to reflect these changes accurately. 3. **Language Rules:** - Ensure the documentation is written in English (unless the file is explicitly a bilingual or translated file). 4. **Reporting:** - If documentation was updated, list the files modified. - If no documentation updates were required, output: **"NO DOCS UPDATE REQUIRED"**. - If documentation is missing but should exist based on the changes, optionally draft a quick documentation snippet and append it to the README or create a new doc file.