diff --git a/README.md b/README.md index b3d0bc6..11959ed 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

AI agents Rules / Skills from
Programming Books v0.5

- AGENTS.md rules / skills for Codex, Cursor, Claude Code, distilled from classic software engineering books about refactoring, architecture, DDD and code quality. + AGENTS.md rules / skills for Codex, Autohand Code, Cursor, Claude Code, distilled from classic software engineering books about refactoring, architecture, DDD and code quality.

@@ -26,7 +26,7 @@ MIT licensed universal project rules for coding agents. This repository contains ready-to-use rule sets inspired by well-known books on software design, architecture, refactoring, legacy code, reliability, and data-intensive systems. -For editor-specific setup in Codex, Claude Code, and Cursor, see [USAGE.md](docs/USAGE.md). It covers always-on vs on-demand usage, skills, scoped rules, MCP or RAG patterns, and the preferred setup for each editor. +For editor-specific setup in Codex, Autohand Code, Claude Code, and Cursor, see [USAGE.md](docs/USAGE.md). It covers always-on vs on-demand usage, skills, scoped rules, MCP or RAG patterns, and the preferred setup for each editor. Each rule set is released in three tool-agnostic Markdown versions: diff --git a/docs/USAGE.md b/docs/USAGE.md index bdb21fd..787a1a7 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -151,6 +151,54 @@ project/ - putting long procedures into `AGENTS.md` - using memories as the primary place for shared rules +## Autohand Code + +### Available mechanisms + +- skills in `.autohand/skills/` or `~/.autohand/skills/` +- project-level instructions when the project already has a reviewed shared baseline +- MCP servers and web search for external context + +### Preferred setup + +Use Autohand Code skills for book-specific workflows, especially when the rule set should activate only for refactoring, legacy-code work, reliability review, or domain modeling. + +Preferred order: + +1. Turn a focused `mini` rule set into a skill under `.autohand/skills/` for the current project or `~/.autohand/skills/` for global reuse. +2. Put one `mini` rule set in the project layer only when that book should shape most tasks. +3. Use `nano` only when the always-on project layer must stay extremely small. +4. Keep `full` files as skill references or retrieval material instead of loading them globally. + +### Recommended version mapping + +- `mini`: preferred skill body; also usable as a compact project-wide default +- `nano`: compact fallback for very tight always-on budgets +- `full`: skill reference, audit source, or focused-session reference + +### Recommended structure + +```text +project/ + .autohand/ + skills/ + refactoring-pass/ + SKILL.md + reference.md +``` + +### Use Autohand Code this way when + +- you want a book-specific skill available to Autohand Code without affecting every task +- a team wants to keep shared skill packages in the repository +- one workflow is repeatable enough to deserve an explicit skill + +### Avoid + +- loading several `full` files globally +- copying every book into the same always-on context +- treating local memories as reviewed team instructions + ## Claude Code ### Available mechanisms