What problem does it solve?
This Skill automates synchronizing documentation with the current Salesforce codebase, eliminating stale READMEs, missing API documentation, and mismatched deployment instructions after code changes.
Core Features & Use Cases
- Project scanning: Read project configuration and source metadata to determine tech stack and component counts (Apex classes, triggers, LWC components, flows, objects).
- README and API updates: Update only auto-generated README sections, generate API documentation for classes annotated with RestResource, AuraEnabled, or InvocableMethod, and create or refresh deployment guides.
- Staleness detection & safety: Flag documentation not updated in 90+ days, preserve manually authored content by only editing between AUTO-GENERATED markers, and always present a diff before writing changes.
- Use case: After adding new Apex classes and LWC components, run the skill to regenerate component counts, append new API endpoints, and refresh deployment instructions so documentation matches the repository.
Quick Start
Use the update-docs skill to scan the repo, regenerate project structure and API documentation, and present a diff before applying changes.