skills-vault/docs/architecture.md

88 lines
2.5 KiB
Markdown

# skills-vault Architecture
## Purpose
`skills-vault` is a monorepo for automation Skill source code.
The repository is intentionally lightweight. It should make Skills easy to find, inspect, test, migrate, and install without turning the repository into an agent framework.
New Skill work should originate from real workflow demand:
- a business system such as `video-workbench`, `writing-workbench`, `knowledge-vault`, or `ccpe-system`
- recurring local workflow automation discovered during day-to-day work
Do not use this repository as a speculative backlog of possible Skills.
## Primary Units
### Skill Source
Each Skill lives under:
```text
skills/<skill-name>/
```
A Skill directory should contain the runnable or installable source for one capability.
### Registry
`registry/skills-index.md` is the human-readable index of Skills in this repository.
It should answer:
- What Skills exist?
- What do they do?
- Where did they come from?
- What is their migration status?
- Are they installed locally?
- Do they have any CCPE registration?
The registry tracks real Skills managed by this repository. It should not be used to pre-register candidate Skills that do not yet come from a real workflow.
### Templates
`templates/skill/` contains a baseline structure for migrated or newly created Skills.
Use templates as starting points, not as strict bureaucracy. Small Skills may omit directories they do not need.
### Scripts
Top-level `scripts/` is for repository-level helper scripts only, such as future install, sync, validation, or registry tools.
Skill-specific scripts should stay inside each Skill directory.
## Non-Goals
This repository does not:
- store CCPE agents
- store CCPE committees
- store CCPE runtimes
- store CCPE model cards
- replace `ccpe-system`
- replace `knowledge-vault`
- act as the local installed runtime directory
## Installation Surface
The local runtime install surface is separate:
```text
C:\Users\wangq\.agents\skills
```
Future sync scripts may copy selected Skill directories from `skills-vault/skills/` into that install directory.
Business systems should normally use installed Skills from `.agents/skills`, not import directly from this development repository. For example, `video-workbench` may raise a need that leads to a Skill source here, but its workflow should call the installed Skill.
## Design Principle
Keep source ownership simple:
```text
Implementation source: skills-vault
Runtime install copy: .agents/skills
Architecture registration: ccpe-system, only when needed
```