project-knowledge-bootstrap

Scans Salesforce project structure to populate project knowledge files with conventions and architecture.

Updated Dec 1, 2025
One-click install
npx skills add https://github.com/jterratsdev/smart-deployment --skill project-knowledge-bootstrap-jterratsdev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-knowledge-bootstrap
Source: https://github.com/jterratsdev/smart-deployment/tree/main/.setup-agents/skills/project-knowledge-bootstrap
Command: npx skills add https://github.com/jterratsdev/smart-deployment --skill project-knowledge-bootstrap-jterratsdev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? When agents or developers start working on a Salesforce codebase, they lack context about naming conventions, architecture patterns, label languages, and codebase layout. This Skill automates the discovery and documentation of that tribal knowledge into structured markdown files. ## Core Features & Use Cases - Codebase Scanning: Detects Salesforce project markers (force-app, sfdx-project.json) and counts artifacts by type (Apex classes, triggers, LWC, flows, objects, permission sets). - Convention Detection: Infers naming conventions from file samples, detects label and description languages, and identifies architecture patterns like trigger handlers, service layers, and async patterns. - Documentation Generation: Populates project-knowledge.md, doc-index.md, and class-catalog.md with architecture decisions, naming tables, codebase maps, and classified Apex/LWC catalogs. - Use Case: An architect agent starting its first task on an unfamiliar Salesforce repo runs this Skill to fill empty project-knowledge sections, so all subsequent agents follow detected conventions instead of guessing. ## Quick Start Scan this Salesforce project and populate the project-knowledge.md file with detected naming conventions, architecture patterns, and a codebase map.

Frequently Asked Questions about project-knowledge-bootstrap

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

FAQPage Schema
How do I document naming conventions in a Salesforce project?

Run this Skill to sample existing Apex classes, triggers, LWC components, and flows, then infer patterns like prefixes or test suffixes. If a pattern appears in 80% or more of files it is recorded; otherwise the convention is left blank with a note to ask the user.

How to detect architecture patterns in a Salesforce codebase?

The Skill greps for trigger handler base classes, service layers, selectors, and async patterns like Queueable, Batchable, and Schedulable implementations. Detected patterns are written into the Architecture Decisions section of project-knowledge.md.

When should the project knowledge bootstrap run?

Run it when an architect agent starts its first task and project-knowledge.md has empty sections, or when any agent detects force-app exists but the Codebase Map section is blank. It is designed for initial onboarding, not continuous updates.

Does this Skill modify Salesforce source code?

No, the Skill is strictly read-only analysis of the codebase. It only writes to documentation files like project-knowledge.md, doc-index.md, and class-catalog.md, never to source metadata.

What happens if the project has no force-app directory?

The Skill checks for alternative source roots such as src/ or app/ and adapts its scanning accordingly. If fewer than three samples exist for a pattern, it marks the finding as insufficient data rather than guessing.