mbrucedogs/ai-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
c88b5e34b9
ai-docs/Agents.md
Matt Bruce 2500b54bcc chore: initial docs
2026-02-10 13:55:42 -06:00

999 B
Raw Blame History

Agents

Purpose

This file defines how to use agent-style workflows in this project so tasks are clear, scoped, and repeatable.

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.

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, AI-Docs-Plan.md Output: Updated troubleshooting section with 5 common issues. Verification: Manual review.