Agent skill
docs
Update all project documentation to match current codebase (Sofia Nakamura's workflow)
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/docs-g-zenr-relay-api
SKILL.md
Update project documentation: $ARGUMENTS
Follow Sofia Nakamura's documentation standards:
-
Audit current state: Read all documentation files and compare against actual codebase
- Project README — API endpoints table, configuration table, examples
- Env example file — every setting with description and default
- App factory description block — feature list and usage info
- OpenAPI metadata on every endpoint (summary, description, responses)
-
README updates:
- API Endpoints table MUST match actual routes in the API layer
- Configuration table MUST match all fields in the config file's Settings class
- Examples MUST work with current API
- Architecture diagram MUST match actual file structure
- Docker section MUST match current Dockerfile
-
Env example file updates:
- Every field in the config file's Settings class MUST have a corresponding line
- Each variable has a comment explaining purpose, options, and default
- Group by category
-
OpenAPI metadata:
- Every endpoint in the API layer MUST have
summaryanddescription - Every endpoint MUST declare
responseswith status codes and models - Check by visiting the docs endpoint or reading route decorators
- Every endpoint in the API layer MUST have
-
API description in the app factory:
- Description string MUST list all current features
- Authentication section matches actual auth behavior
- Rate limiting section matches actual middleware behavior
-
Output: List every change made and every discrepancy found
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?