원클릭으로
docs-engineering
// Audit and update all project documentation to stay in sync with the current development status.
// Audit and update all project documentation to stay in sync with the current development status.
| name | docs-engineering |
| description | Audit and update all project documentation to stay in sync with the current development status. |
When performing documentation engineering, always follow these steps:
Audit all documentation against the current codebase and development status. The review scope must include — without exception:
README.md — features list, prerequisites, acknowledgementsCLAUDE.md — stack, architecture, key gotchas, project conventionsdoc/ — development.md, sysop.md, api.md, troubleshooting.md, TODOs.md@moduledoc and @doc strings in changed or related modulesRevise and update any documentation that is stale, incomplete, or inconsistent with the current code. Ensure new features, removed dependencies, behavioral changes, and architectural decisions are reflected accurately.
Remove completed items from doc/TODOs.md. If a summary of completed work is warranted, add a brief note before removing the items.
Commit documentation changes in Git, grouped by topic. Do not mix unrelated documentation changes in a single commit.
Perform a project-wide full-scope code review covering correctness, security auditing, test coverage, locale sync, documentation quality, code smells, UI/UX accessibility, and project conventions, then report findings and fix critical issues.
Manage the full software release process, including version bumps, changelogs, Git tags, and GitHub releases.
Stage, commit, and push changes to the remote repository with a well-formed commit message.