43 lines
1.3 KiB
Markdown
43 lines
1.3 KiB
Markdown
# Agents
|
|
|
|
## Purpose
|
|
This file defines how to use agent-style workflows in this project so tasks are clear, scoped, and repeatable.
|
|
|
|
## Sync Expectation
|
|
Keep this file aligned with PRD and README when workflows, scope, or structure change.
|
|
|
|
## When to Use Agents
|
|
- Multi-step changes across files.
|
|
- Refactors with clear acceptance criteria.
|
|
- Audits or documentation updates.
|
|
|
|
## Common Agent Use Cases
|
|
- Create or expand documentation sections.
|
|
- Plan a refactor before making edits.
|
|
- Summarize and assess risks across files.
|
|
|
|
## How to Use Agents
|
|
1. Define the outcome in one sentence.
|
|
2. List inputs (files, context, constraints).
|
|
3. Ask for a plan, then approve before edits.
|
|
4. Ask for focused changes and verification steps.
|
|
|
|
## Skills Sync
|
|
This repo uses a skills manifest to standardize skills across developers.
|
|
|
|
1. Review skills.yaml for required skills.
|
|
2. Run ./scripts/sync-skills.sh to sync skills locally.
|
|
3. Restart your editor if needed.
|
|
|
|
## Suggested Agent Request Template
|
|
- Goal: (one sentence)
|
|
- Inputs: (files, context, constraints)
|
|
- Output: (expected deliverable)
|
|
- Verification: (tests or checks)
|
|
|
|
## Example
|
|
Goal: Add a troubleshooting section to the AI docs.
|
|
Inputs: docs/ai/troubleshooting.md, docs/planning/AI-Docs-Plan.md
|
|
Output: Updated troubleshooting section with 5 common issues.
|
|
Verification: Manual review.
|