update-docs

Synchronize Salesforce README and API docs with source metadata.

13|2|Updated Mar 18, 2026
One-click install
npx skills add https://github.com/jiten-singh-shahi/salesforce-claude-code --skill update-docs-jiten-singh-shahi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/jiten-singh-shahi/salesforce-claude-code/tree/main/.cursor/skills/update-docs
Command: npx skills add https://github.com/jiten-singh-shahi/salesforce-claude-code --skill update-docs-jiten-singh-shahi

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about update-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate Salesforce documentation sync with Apex and LWC changes?

You can synchronize Salesforce docs by scanning source folders and metadata to update auto-generated README sections, generate API docs for annotated Apex methods, and refresh deployment references whenever code changes occur.

How does stale documentation detection work for Salesforce repositories?

Stale documentation detection flags files older than 90 days. The skill scans your Salesforce repository to identify outdated README files and API docs, ensuring deployment references match the current codebase.

Can I preserve manually written README content when auto-generating API docs?

You can preserve manually authored content because the skill only updates sections between designated auto-generated markers. It generates API entries for annotated Apex methods while leaving manually written README content untouched.

Does this documentation sync tool work with Apex classes annotated with RestResource and AuraEnabled?

The tool works with Apex classes annotated with RestResource, AuraEnabled, or InvocableMethod. It scans these annotations to generate corresponding API documentation entries and update project references automatically.

What is the best way to update deployment guides after adding new LWC components?

Update deployment guides by running a project scan that inventories new LWC components and metadata changes. The skill refreshes deployment instructions and component counts, then presents a diff before writing any changes.

Will I see a diff before the tool writes changes to my README?

You will see a diff before any changes are written. The skill always presents a diff of the updated auto-generated sections, API documentation, and deployment references before applying modifications to your files.