← Files AkinatorARCHIVED FILE

templates/README.md

2.74 KB · Oct 3, 2026 · 06:33 UTC

↓ Download file

# Templates

What Akinator writes into target repositories. Fourteen templates, each with a filled
example in `examples/`.

A template is a skeleton with placeholders. The example is the same document
filled in properly - particularly the sections that are usually left thin.

| Template | For | Example |
|---|---|---|
| [rule.md](rule.md) | A constraint others must not break, with a real enforcement mechanism | [example](examples/rule.md) |
| [skill.md](skill.md) | A repeatable procedure, with all six required parts | [example](examples/skill.md) |
| [context-map.md](context-map.md) | Structural facts, generated where possible | [example](examples/context-map.md) |
| [memory.md](memory.md) | One durable fact, with its why and reversal conditions | [example](examples/memory.md) |
| [adr.md](adr.md) | A decision, with its rejected options and their costs | [example](examples/adr.md) |
| [business-logic.md](business-logic.md) | Money and entitlement rules, in business language | [example](examples/business-logic.md) |
| [product-feature.md](product-feature.md) | Feature intent and the edge-case decision log | [example](examples/product-feature.md) |
| [ops-runbook.md](ops-runbook.md) | An operational procedure, with its point of no return | [example](examples/ops-runbook.md) |
| [router.md](router.md) | Thin CLAUDE.md / AGENTS.md / CODEX.md index skeletons | [example](examples/router.md) |
| [onboarding-mapping.md](onboarding-mapping.md) | Adopt-never-impose, recorded as a contract | [example](examples/onboarding-mapping.md) |
| [change-record.md](change-record.md) | Durable before → change → now provenance, intent and verification | [example](examples/change-record.md) |
| [library-page.md](library-page.md) | One load-bearing dependency: generated facts, plus why we use it, how, what bit us and how to upgrade | [example](examples/library-page.md) |
| [requirement.md](requirement.md) | One requirements-register entry - current, changed, missing or dropped - with its source and append-only history | [example](examples/requirement.md) |
| [business-drift.md](business-drift.md) | One change of direction: before, after, why, who decided, impact, and every page it made untrue | [example](examples/business-drift.md) |

All fourteen examples are written against **one** fictional product, so they
cross-reference each other the way real artifacts do. See
[examples/README.md](examples/README.md).

## Adopt, never impose

These are defaults, not requirements. When a target repository already has a
format for a kind of knowledge, use **its** format - its numbering, its
frontmatter, its index style - and record the mapping with
`onboarding-mapping.md`. Creating a parallel structure beside an existing one is
the most damaging thing this plugin can do to a repository.

SHA-256: 0a0f9c851e368b532a26eed4cab91b513438a0a65fd8d9f39a72299a9f9c8d60