Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<h1 align="center">AI agents Rules / Skills from<br />Programming Books v0.5</h1>

<p align="center">
<strong>AGENTS.md rules</strong> / <strong>skills</strong> for <strong>Codex</strong>, <strong>Cursor</strong>, <strong>Claude Code</strong>, distilled from classic <strong>software engineering books</strong> about refactoring, architecture, DDD and code quality.
<strong>AGENTS.md rules</strong> / <strong>skills</strong> for <strong>Codex</strong>, <strong>Autohand Code</strong>, <strong>Cursor</strong>, <strong>Claude Code</strong>, distilled from classic <strong>software engineering books</strong> about refactoring, architecture, DDD and code quality.
</p>

<p align="center">
Expand All @@ -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:

Expand Down
48 changes: 48 additions & 0 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down