Compound docs

Skill divingsbysangam/salesforce-compound-engineering-plugin/skills/compound-docs

Guide for writing solution documents that feed the institutional knowledge system under docs/solutions/. Use when compounding learnings, authoring solution YAML frontmatter, or teaching /sf-compound output shape.From its SKILL.md

Install

npx -y skills add divingsbysangam/salesforce-compound-engineering-plugin --skill compound-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

10 stars10 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

7.0 KB, as published. Nobody here has run it

Compound Docs Skill

Guide for writing solution documents that feed the institutional knowledge system.

Solution Document Template

Every solution in docs/solutions/ follows this structure:

---
title: "{Short descriptive title}"
date: YYYY-MM-DD
category: {category}
severity: {critical|high|medium|low}
tags: ["{tag1}", "{tag2}"]
---

## Symptoms
{What went wrong — error messages, unexpected behavior}

## Root Cause
{Why it happened — technical explanation}

## Resolution
{How it was fixed — specific changes}

## Prevention
{How to avoid this in future}

## Related Files
- {file_path}:{line_number}

Categories

<span data-proof="authored" data-by="ai:claude">Category</span>	<span data-proof="authored" data-by="ai:claude">Directory</span>	<span data-proof="authored" data-by="ai:claude">Use For</span>
<span data-proof="authored" data-by="ai:claude">governor-limits</span>	<span data-proof="authored" data-by="ai:claude">`governor-limit-issues/`</span>	<span data-proof="authored" data-by="ai:claude">SOQL 101, DML 150, CPU timeout, heap size</span>
<span data-proof="authored" data-by="ai:claude">deployment</span>	<span data-proof="authored" data-by="ai:claude">`deployment-issues/`</span>	<span data-proof="authored" data-by="ai:claude">Deploy failures, metadata conflicts, version issues</span>
<span data-proof="authored" data-by="ai:claude">test-failure</span>	<span data-proof="authored" data-by="ai:claude">`test-failures/`</span>	<span data-proof="authored" data-by="ai:claude">Flaky tests, coverage gaps, assertion errors</span>
<span data-proof="authored" data-by="ai:claude">security</span>	<span data-proof="authored" data-by="ai:claude">`security-issues/`</span>	<span data-proof="authored" data-by="ai:claude">CRUD/FLS, injection, sharing, encryption</span>
<span data-proof="authored" data-by="ai:claude">integration</span>	<span data-proof="authored" data-by="ai:claude">`integration-issues/`</span>	<span data-proof="authored" data-by="ai:claude">Callout failures, auth, Named Credentials</span>
<span data-proof="authored" data-by="ai:claude">flow</span>	<span data-proof="authored" data-by="ai:claude">`flow-issues/`</span>	<span data-proof="authored" data-by="ai:claude">Flow errors, recursion, limits, versioning</span>
<span data-proof="authored" data-by="ai:claude">lwc</span>	<span data-proof="authored" data-by="ai:claude">`lwc-issues/`</span>	<span data-proof="authored" data-by="ai:claude">Rendering, wire service, events, lifecycle</span>
<span data-proof="authored" data-by="ai:claude">data-model</span>	<span data-proof="authored" data-by="ai:claude">`data-model-issues/`</span>	<span data-proof="authored" data-by="ai:claude">Relationships, indexes, skew, limits</span>
<span data-proof="authored" data-by="ai:claude">best-practice</span>	<span data-proof="authored" data-by="ai:claude">`best-practices/`</span>	<span data-proof="authored" data-by="ai:claude">Proven patterns, recommended approaches</span>
<span data-proof="authored" data-by="ai:claude">pattern</span>	<span data-proof="authored" data-by="ai:claude">`patterns/`</span>	<span data-proof="authored" data-by="ai:claude">Reusable design patterns, architectural decisions</span>

Naming Convention

Files: docs/solutions/{category}/YYYY-MM-DD-{slug}.md

Examples:

docs/solutions/governor-limit-issues/2026-03-02-soql-101-account-trigger.md
docs/solutions/best-practices/2026-03-02-wire-service-caching-pattern.md

YAML Frontmatter Validation

Validate against schema.yaml in the project root. Required fields:

title (string)
date (YYYY-MM-DD)
category (enum — must match a category above)
severity (enum — critical/high/medium/low)
tags (list of strings)

Writing Tips

Be specific: Include exact error messages, not paraphrases
Include context: API version, org type, user profile
Link to code: Reference file paths and line numbers
Make it searchable: Use tags that others would search for
Focus on prevention: The most valuable part is how to avoid the issue

Compound docs

One thing to look at

SKILL.md

<span data-proof="authored" data-by="ai:claude">Compound Docs Skill</span>

<span data-proof="authored" data-by="ai:claude">Solution Document Template</span>

<span data-proof="authored" data-by="ai:claude">Categories</span>

<span data-proof="authored" data-by="ai:claude">Naming Convention</span>

<span data-proof="authored" data-by="ai:claude">YAML Frontmatter Validation</span>

<span data-proof="authored" data-by="ai:claude">Writing Tips</span>

Keep looking