mirror of
https://github.com/boshu2/agentops.git
synced 2026-09-14 15:08:13 +08:00
9.6 KiB
9.6 KiB
Documentation Index
Master table of contents for AgentOps documentation.
Getting Started
- README — Project overview and quick start
- FAQ — Comparisons, limitations, subagent nesting, uninstall
- CONTRIBUTING — How to contribute
- AGENTS.md — Local agent instructions for this repo
- Changelog — Release history
- Security — Vulnerability reporting
Architecture
- How It Works — Brownian Ratchet, Ralph Wiggum Pattern, agent backends, hooks, context windowing
- Architecture — System design and component overview
- Architecture Folder Index — Architecture subdocs overview
- AO-Olympus Ownership Matrix — Responsibility split for skills, runtime, and bridge contracts
- PDC Framework — Prevent, Detect, Correct quality control approach
- FAAFO Alignment — FAAFO promise framework for vibe coding value
- Failure Patterns — The 12 failure patterns reference guide
Skills
- Skills Reference — Complete reference for all AgentOps skills
- Skill Tiers — Taxonomy and dependency graph
- Testing Skills — Guide for writing and running skill tests
- Claude Code Skills Docs — Official Claude Code skills documentation (upstream)
Workflows
- Workflow Guide — Decision matrix for choosing the right workflow
- Complete Cycle — Full Research, Plan, Implement, Validate, Learn workflow
- Session Lifecycle — Complete guide to working with Claude across sessions
- Quick Fix — Fast implementation for simple, low-risk changes
- Debug Cycle — Systematic debugging from symptoms to root cause to fix
- Knowledge Synthesis — Extract and synthesize knowledge from multiple sources
- Assumption Validation — Validate research assumptions before planning
- Post-Work Retro — Systematic retrospective after completing work
- Multi-Domain — Coordinate work spanning multiple domains
- Continuous Improvement — Ongoing system optimization and pattern refinement
- Infrastructure Deployment — Orchestrate deployment with validation gates
- Meta-Observer Pattern — Autonomous multi-session coordination
Meta-Observer
- Meta-Observer README — Complete workflow package overview
- Pattern Guide — Autonomous multi-session coordination guide
- Example Session — Real example from 2025-11-09
- Showcase — Distributed intelligence for multi-session work
Concepts
- Knowledge Flywheel — How every session makes the next one smarter
- The Science — Research behind knowledge decay and compounding
- Brownian Ratchet — AI-native development philosophy
Standards
- Standards Overview — Coding standards index
- Go Style Guide — Go coding conventions
- TypeScript Standards — TypeScript coding conventions
- Python Style Guide — Python coding conventions
- Shell Script Standards — Shell script conventions
- Markdown Style Guide — Markdown formatting conventions
- JSON/JSONL Standards — JSON and JSONL conventions
- YAML/Helm Standards — YAML and Helm chart conventions
- Tag Vocabulary — Standard tag definitions
Levels
- Levels Overview — Progressive learning path
L1 — Basics
- L1 README — Single-session work with Claude Code
- Research — Explore a codebase to understand how it works
- Implement — Make changes, validate, commit
- Demo: Research Session — Example research session
- Demo: Implement Session — Example implement session
L2 — Persistence
- L2 README — Cross-session memory with .agents/
- Research — Explore codebase and save findings
- Retro — Extract session learnings
- Demo: Research Session — Example persistent research
- Demo: Retro Session — Example retro session
L3 — State Management
- L3 README — Issue tracking with beads
- Plan — Decompose goals into tracked issues
- Implement — Execute, validate, commit, close
- Demo: Plan Session — Example planning session
- Demo: Implement Session — Example implement session
L4 — Parallelization
- L4 README — Wave-based parallel execution
- Implement Wave — Execute unblocked issues in parallel
- Demo: Wave Session — Example wave execution
L5 — Orchestration
- L5 README — Full autonomous operation with /crank
- Crank — Execute epics to completion
- Demo: Crank Session — Example crank session
Profiles
- Profiles Overview — Role-based profile organization
- Profile Comparison — Workspace profiles vs 12-Factor examples
- Meta-Patterns — Patterns extracted from role-based taxonomy
- Example: Software Dev — Software development session
- Example: Platform Ops — Platform operations session
- Example: Content Creation — Content creation session
Comparisons
- Comparisons Overview — AgentOps vs the competition
- vs SDD — AgentOps vs Spec-Driven Development
- vs GSD — AgentOps vs Get Shit Done
- vs Superpowers — AgentOps vs Superpowers plugin
- vs Claude-Flow — AgentOps vs Claude-Flow orchestration
Positioning
- Positioning Overview — Product and messaging foundations
- DevOps for Vibe-Coding — Strategic foundation document
- 12 Factors Validation Lens — Shift-left validation for coding agents
Plans
- Plans Overview — Time-stamped plans index
- Validated Release Pipeline — Release pipeline design (2026-01-28)
- AO-Olympus Bridge Next Steps — Follow-up work to make the AO↔OL bridge enforceable (2026-02-13)
Templates
- Templates Overview — Templates index
- Workflow Template — Template for new workflows
- Agent Template — Template for new agents
- Skill Template — Template for new skills
- Command Template — Template for new commands
- Kernel Template — Template for new project kernels
- Product Template — Template for writing a PRODUCT.md
Reference
- Glossary — Definitions of domain-specific terms (Beads, Brownian Ratchet, RPI, etc.)
- CLI Reference — Complete
aocommand reference - Reference — Deep documentation and pipeline details
- Releasing — Release process for ao CLI and plugin
- Troubleshooting — Common issues and quick fixes
- Incident Runbook — Operational runbook for incidents and recovery
- AO Command Customization Matrix — External command dependencies and customization policy tiers
- OL-AO Bridge Contracts — Olympus-AgentOps interchange formats
- MemRL Policy Integration — AO-exported deterministic MemRL policy contract for Olympus hooks
- MemRL Policy Schema — Machine-readable schema for MemRL policy package
- MemRL Policy Example Profile — Example deterministic policy profile