update_docs
Updates standard project documentation files (README, CODE_DOCUMENTATION, DESIGN_PHILOSOPHY) to reflect the current state of the codebase.
Best use case
update_docs is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Updates standard project documentation files (README, CODE_DOCUMENTATION, DESIGN_PHILOSOPHY) to reflect the current state of the codebase.
Teams using update_docs should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/update_docs/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How update_docs Compares
| Feature / Agent | update_docs | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Updates standard project documentation files (README, CODE_DOCUMENTATION, DESIGN_PHILOSOPHY) to reflect the current state of the codebase.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Update Documentation
This skill systematically updates the core documentation files of the project.
## Inputs
* **Changes**: Summary of what changed (or ask Agent to scan).
* **Docs to Update**: README, CODE_DOCUMENTATION, etc.
## Tooling Strategy
* Use `view_file` to read current docs.
* Use `replace_file_content` to update sections.
## Workflow
1. **Analyze Changes**: Briefly scan the recent changes in the codebase to understand what functionality has been added, modified, or removed.
2. **Update README.md**:
* **Focus**: "HOW TO'S".
* Ensure installation and usage instructions are up to date.
* Add any new features to the feature list.
* Verify prerequisites and configuration steps.
3. **Update CODE_DOCUMENTATION.md**:
* **Focus**: "Code functionality - crisp, clear, and simple".
* Describe the technical implementation of new features.
* Update architecture diagrams or descriptions if flow has changed.
* Keep it concise; avoid over-explaining standard boilerplate.
4. **Update DESIGN_PHILOSOPHY.md**:
* **Focus**: "Why and what are we trying to do - ideology".
* Explain the *reasoning* behind recent major changes.
* Re-align the document with the project's evolving goals if necessary.
* Ensure the tone reflects the project's core values.
5. **Review**: Check for consistency across all three documents.Related Skills
web_performance_optimization
Optimize website and web application performance including loading speed, Core Web Vitals, bundle size, caching strategies, and runtime performance.
ui_ux_pro_max
UI/UX design intelligence with searchable database of patterns, styles, and stacks.
security_audit
Scans the codebase for OWASP Top 10 vulnerabilities (Secrets, Injection, Auth) and manages SECURITY.md.
scaffold_tests
Generates unit and regression test files for existing code. Creates "Happy Path", "Edge Case", and "Error" test stubs.
repo_infographic
Generates a crisp, clear full infographic of the repository with a unique theme based on the repo's content. Saves the infographic to the assets folder and links it in the README.md file.
release_helper
Automates release note generation and social media announcements. Handles version incrementing (minor vs major).
optimize_codebase
Identifies and refactors monolithic files (>2k lines) into modular, performance-safe component structures.
open_source_prep
Comprehensive workflow to prepare a project for public open-source release. Handles licensing, username normalization, code integrity checks, and documentation generation.
list_features
Scans the codebase to generate a comprehensive, prompt-based feature list in 'features_listed.md' for recreating the app in any language.
idea_to_action
Transforms abstract ideas into execution-ready systems. Follows the Brainstorm → Filter → Execute pipeline with a "Reality-First" founder mindset.
generate_release_image
create or edit promotional images for releases, adding version numbers, feature highlights, and modern styling.
frontend_design
Create distinctive, production-grade frontend interfaces with high design quality. Use this when building web components, pages, artifacts, posters, or applications (websites, landing pages, react components). Generates creative, polished code that avoids generic aesthetics.