Added docs/SOP-shared-resources.md covering: - Single repo vs multi-repo directory structures - Mounting strategies (copy, symlinks, git submodules, npm packages) - What to share vs what to keep project-specific - Referencing shared resources in tasks and prompts - Versioning and update protocols - Migration checklist Updated GETTING-STARTED.md to reference the new prompt-registry templates. Credit: BoardKit Orchestrator (Monika Voutov) for the shared resources pattern. Closes #77
5.3 KiB
SOP: Shared Resources Registry
Keep prompts, skills, and guidelines in sync across repos and agents.
Why Shared Resources?
"Update once, propagate everywhere." — BoardKit Orchestrator
Without a shared registry:
- Prompts drift between repos
- Agents in different projects behave inconsistently
- SOPs get outdated and forgotten
- New team members copy/paste stale templates
With a shared registry:
- Single source of truth for agent behavior
- Consistent task workflows across all projects
- Easy onboarding (point to the registry)
- Version-controlled evolution
Directory Structure
Single Repo (Simple)
my-project/
├── prompt-registry/ # Workflow prompts
│ ├── sprint-planning.md
│ ├── code-review.md
│ └── ...
├── AGENTS.md # Agent personality/rules
├── CLAUDE.md # Model-specific notes
└── docs/
└── BEST-PRACTICES.md # Team patterns
Multi-Repo (Shared Assets)
workspace/
├── shared/ # Shared across all repos
│ ├── prompt-registry/ # Universal prompts
│ │ ├── sprint-planning.md
│ │ └── cross-model-review.md
│ ├── skills/ # Agent skills/capabilities
│ │ ├── github.md
│ │ └── research.md
│ └── guidelines/ # Universal rules
│ ├── AGENTS-BASE.md
│ └── SECURITY-RULES.md
│
├── project-a/ # Project-specific
│ ├── AGENTS.md # Extends shared/guidelines/AGENTS-BASE.md
│ ├── prompt-registry/ # Project-specific prompts
│ │ └── deploy-checklist.md
│ └── ...
│
└── project-b/
├── AGENTS.md
└── ...
Mounting Strategies
Strategy 1: Copy + Customize (Recommended for MVP)
Copy shared resources into each repo, customize as needed:
# Initial setup
cp -r ../shared/prompt-registry ./prompt-registry
cp ../shared/guidelines/AGENTS-BASE.md ./AGENTS.md
# Periodically sync
diff -u ../shared/prompt-registry ./prompt-registry
# Review changes, merge manually
Pros: Simple, no tooling required, full control per repo Cons: Manual sync, potential drift
Strategy 2: Symlinks
Link shared resources into each repo:
# From project directory
ln -s ../shared/prompt-registry ./prompt-registry-shared
ln -s ../shared/guidelines/AGENTS-BASE.md ./AGENTS-SHARED.md
Pros: Always in sync, no manual updates Cons: Doesn't work on Windows, requires absolute paths for some tools
Strategy 3: Git Submodules
Maintain shared resources in a separate repo:
# Add submodule
git submodule add https://github.com/org/shared-resources.git shared
# Update
git submodule update --remote
Pros: Versioned, works across orgs Cons: Git submodule complexity
Strategy 4: NPM/pnpm Package (Future)
Publish shared resources as a package:
{
"dependencies": {
"@org/agent-resources": "^1.0.0"
}
}
Pros: Semantic versioning, automatic updates Cons: Requires package infrastructure
What to Share
Always Share
- Cross-model review prompt (consistency is critical)
- Security review checklist
- Definition of Done template
- Sprint planning prompt
Share Carefully
- Agent personality (AGENTS.md) — may need project-specific tweaks
- API endpoint references — URLs differ per environment
- Notification channels — project-specific
Don't Share
- Secrets or API keys (use env vars)
- Project-specific business logic
- Team member names/contacts
Referencing Shared Resources
In Task Descriptions
## Instructions
Follow the standard code review process.
See prompt: `prompt-registry/cross-model-review.md`
In Agent Prompts
You are working on project-a. Use the shared guidelines at `shared/guidelines/AGENTS-BASE.md`
combined with project-specific rules at `AGENTS.md`.
In AGENTS.md
# AGENTS.md
This project extends the base guidelines at `../shared/guidelines/AGENTS-BASE.md`.
## Project-Specific Rules
- Use project-a-specific API at http://localhost:4000
- Deploy requires approval from @project-lead
Versioning & Updates
Semantic Versioning for Shared Resources
shared/
├── VERSION # 1.2.0
├── CHANGELOG.md # What changed
└── prompt-registry/
└── ...
Update Protocol
- Propose — Create PR/issue in shared resources repo
- Review — Team reviews impact across all projects
- Test — Verify in one project first
- Propagate — Update all repos (manual or via sync script)
- Announce — Notify team of changes
Migration Checklist
Moving from ad-hoc prompts to shared registry:
- Audit existing prompts across all repos
- Identify duplicates and conflicts
- Create canonical versions in shared location
- Update all repos to reference shared versions
- Remove duplicate copies
- Document the new structure in each repo's README
- Train team on update protocol
Credit
Shared resources pattern inspired by BoardKit Orchestrator by Monika Voutov.