Skip to content

hashgraph-online/awesome-codex-plugins / plugins/alpoxdev/hypercore/skills/hyper-documentation

hyper-documentation

Flagged

[Hyper] Use this skill when the user asks to create, refactor, or update a documentation artifact: a project or package README.md, a repository AGENTS.md with its AGENTS.ko.md mirror, an AI-readable instruction base, runbook, specification, or rule pack, a reusable prompt, prompt template, prompt pack, or prompt eval fixture, or an agent's persistent memory files (MEMORY.md index, memory bank, lessons file) with their write, pruning, and deletion rules. It picks one mode from the requested output and grounds every claim in the project and its sources. Do not use for reusable skill folders, CHANGELOG, CONTRIBUTING, LICENSE, release notes, answer-only research, or implementation work; it never writes CLAUDE.md.

FileKindSize
SKILL.ko.mdmarkdown21.2 KB
SKILL.mdskill md19.3 KB
assets/evals/hyper-documentation-cases.jsonlother90.3 KB
assets/prompt/eval-harness.template.jsonconfig3.0 KB
assets/prompt/prompt-pack.template.ko.mdmarkdown2.1 KB
assets/prompt/prompt-pack.template.mdmarkdown1.9 KB
assets/prompt/source-ledger.template.ko.mdmarkdown2.1 KB
assets/prompt/source-ledger.template.mdmarkdown2.0 KB
references/memory/evidence-ledger.ko.mdmarkdown55.2 KB
references/memory/evidence-ledger.mdmarkdown51.1 KB
references/official/anthropic.ko.mdmarkdown12.7 KB
references/official/anthropic.mdmarkdown11.9 KB
references/official/openai.ko.mdmarkdown13.5 KB
references/official/openai.mdmarkdown12.8 KB
references/prompt/eval-harness-guide.ko.mdmarkdown5.8 KB
references/prompt/eval-harness-guide.mdmarkdown5.3 KB
references/prompt/prompt-pack-schema.ko.mdmarkdown3.9 KB
references/prompt/prompt-pack-schema.mdmarkdown3.6 KB
references/readme/readme-templates.ko.mdmarkdown4.4 KB
references/readme/readme-templates.mdmarkdown4.1 KB
rules/agents-md/instruction-design.ko.mdmarkdown13.8 KB
rules/agents-md/instruction-design.mdmarkdown12.6 KB
rules/agents-md/mode-contract.ko.mdmarkdown18.4 KB
rules/agents-md/mode-contract.mdmarkdown17.0 KB
rules/agents-md/nested-placement.ko.mdmarkdown3.5 KB
rules/agents-md/nested-placement.mdmarkdown3.2 KB
rules/agents-md/project-discovery.ko.mdmarkdown8.2 KB
rules/agents-md/project-discovery.mdmarkdown7.7 KB
rules/agents-md/rule-file-splitting.ko.mdmarkdown5.9 KB
rules/agents-md/rule-file-splitting.mdmarkdown5.2 KB
rules/agents-md/validation.ko.mdmarkdown10.2 KB
rules/agents-md/validation.mdmarkdown9.4 KB
rules/docs/context-engineering.ko.mdmarkdown13.1 KB
rules/docs/context-engineering.mdmarkdown12.0 KB
rules/docs/forbidden-patterns.ko.mdmarkdown6.0 KB
rules/docs/forbidden-patterns.mdmarkdown5.8 KB
rules/docs/harness-engineering.ko.mdmarkdown15.1 KB
rules/docs/harness-engineering.mdmarkdown13.7 KB
rules/docs/layer-model.ko.mdmarkdown1.3 KB
rules/docs/layer-model.mdmarkdown1.3 KB
rules/docs/mode-contract.ko.mdmarkdown13.1 KB
rules/docs/mode-contract.mdmarkdown12.7 KB
rules/docs/required-behaviors.ko.mdmarkdown9.4 KB
rules/docs/required-behaviors.mdmarkdown8.7 KB
rules/docs/sourcing.ko.mdmarkdown5.7 KB
rules/docs/sourcing.mdmarkdown5.3 KB
rules/docs/structured-reasoning.ko.mdmarkdown2.9 KB
rules/docs/structured-reasoning.mdmarkdown2.8 KB
rules/docs/validation.ko.mdmarkdown10.0 KB
rules/docs/validation.mdmarkdown9.3 KB
rules/memory/lifecycle.ko.mdmarkdown5.6 KB
rules/memory/lifecycle.mdmarkdown4.8 KB
rules/memory/mode-contract.ko.mdmarkdown8.3 KB
rules/memory/mode-contract.mdmarkdown6.9 KB
rules/memory/safety.ko.mdmarkdown5.9 KB
rules/memory/safety.mdmarkdown5.3 KB
rules/memory/structure.ko.mdmarkdown6.1 KB
rules/memory/structure.mdmarkdown5.3 KB
rules/memory/validation.ko.mdmarkdown3.8 KB
rules/memory/validation.mdmarkdown3.4 KB
rules/mode-routing.ko.mdmarkdown6.1 KB
rules/mode-routing.mdmarkdown5.7 KB
rules/prompt/anti-patterns.ko.mdmarkdown2.4 KB
rules/prompt/anti-patterns.mdmarkdown2.3 KB
rules/prompt/artifact-levels.ko.mdmarkdown1.1 KB
rules/prompt/artifact-levels.mdmarkdown1.1 KB
rules/prompt/context-source-safety.ko.mdmarkdown5.2 KB
rules/prompt/context-source-safety.mdmarkdown4.6 KB
rules/prompt/evaluation-and-iteration.ko.mdmarkdown6.9 KB
rules/prompt/evaluation-and-iteration.mdmarkdown6.3 KB
rules/prompt/mode-contract.ko.mdmarkdown14.7 KB
rules/prompt/mode-contract.mdmarkdown14.0 KB
rules/prompt/prompt-contract.ko.mdmarkdown6.8 KB
rules/prompt/prompt-contract.mdmarkdown6.1 KB
rules/prompt/prompt-pack-workflow.ko.mdmarkdown3.0 KB
rules/prompt/prompt-pack-workflow.mdmarkdown2.7 KB
rules/readme/mode-contract.ko.mdmarkdown8.1 KB
rules/readme/mode-contract.mdmarkdown7.1 KB
rules/readme/project-discovery.ko.mdmarkdown6.1 KB
rules/readme/project-discovery.mdmarkdown5.5 KB
rules/readme/section-design.ko.mdmarkdown5.5 KB
rules/readme/section-design.mdmarkdown4.9 KB
rules/readme/validation.ko.mdmarkdown2.9 KB
rules/readme/validation.mdmarkdown2.6 KB

rules/mode-routing.md

View on GitHub
# Mode Routing

> Pick exactly one mode from the requested output, then load only that mode's files.

**Purpose**: Decide which of the five modes owns the request, or send the request out of this skill. **Read when**: every run, before the selected mode's first phase.

## 1. Modes

| Mode | Requested output | Typical words | Mode contract |
|---|---|---|---|
| `readme` | A project `README.md`, or a package `README.md` inside a monorepo, written from the codebase | README, 리드미, "프로젝트 소개 문서", install/usage section | `rules/readme/mode-contract.md` |
| `agents-md` | A root or nested `AGENTS.md`, its adjacent `rules/*.md` split, and its `AGENTS.ko.md` mirror | AGENTS.md, "에이전트 지침 파일", nested AGENTS.md | `rules/agents-md/mode-contract.md` |
| `prompt` | A reusable role, system, developer, agent, or task prompt; a prompt template or prompt pack; a prompt eval fixture, judge contract, or regression suite | prompt, 프롬프트, system prompt, template, prompt pack, eval fixture | `rules/prompt/mode-contract.md` |
| `docs` | Any other AI-readable document: an instruction base, agent guide, runbook, operating procedure, specification, policy or rule pack, or harness documentation | 런북, 가이드, 운영 절차, 명세, 규칙 팩, runbook, rule pack | `rules/docs/mode-contract.md` |
| `memory` | The files an agent reads to remember across sessions: a `MEMORY.md` index with topic files, a memory bank, a lessons or learned file, a user-profile file, and the rules for writing, pruning, and deleting them | 메모리 파일, MEMORY.md, memory bank, 교훈 파일, 기억 규칙, agent memory | `rules/memory/mode-contract.md` |

## 2. Selection Order

Apply these in order; the first match wins.

1. The request names `README.md` as the output: `readme`.
2. The request names `AGENTS.md`, `AGENTS.ko.md`, a nested `AGENTS.md`, or the `rules/*.md` split of one: `agents-md`.
3. The request names `CLAUDE.md`, `.claude/CLAUDE.md`, or `CLAUDE.local.md` as the output: `agents-md`, boundary only. State that this skill produces `AGENTS.md` and `AGENTS.ko.md` alone, offer that output, and do not create, edit, symlink, rename, or delete the requested file.
4. The output is a memory file set or the rules for one (`MEMORY.md`, a memory bank, a lessons file, a user profile, a memory directory): `memory`.
5. The output will be reused as an instruction contract or an eval target: `prompt`.
6. The output is any other structured document that an agent or maintainer loads and follows: `docs`.

## 3. Tie-Breaks

- **Two outputs in one request** ("README랑 AGENTS.md 둘 다"): run the modes one after another in the order the user listed them. Each mode keeps its own contract, gates, and report section; never merge two contracts into one pass.
- **"Document this project" with no file named**: a project landing page for people who install or use the code is `readme`; an operating guide, runbook, or instruction base is `docs`. When neither the request nor the repository decides it and the wrong choice would redo the work, ask one question with both readings and a recommendation.
- **Prompt or document**: choose `prompt` only when the output will be reused as an instruction contract or an eval target. A guide *about* prompt engineering is `docs`.
- **Prompts inside a skill folder**: `prompt` owns only the prompt files the request names. The skill folder itself is out of scope (§4).
- **Runtime rule pack**: anchored in `AGENTS.md` is `agents-md`; any other runtime rule pack is `docs`.
- **Memory or instruction file**: a rule that must hold every time belongs in `AGENTS.md` (`agents-md`); a durable fact the code cannot show belongs in memory (`memory`). A request for both runs `agents-md`, then `memory`, in the order the user listed them. The `memory` mode never writes `AGENTS.md`.
- **A one-sentence wording fix for the current reply**: answer directly; it is not a reusable prompt.

## 4. Out of Scope

Route these away by the shape of their output, not by naming another owner:

- A reusable skill folder (`SKILL.md` plus its rules, references, scripts, and assets).
- `CHANGELOG.md`, `CONTRIBUTING.md`, `LICENSE`, release notes, or a version bump.
- Answer-only research or a one-off answer with no saved artifact.
- Product code, configuration, or tests, where documentation is a by-product.
- A product planning package (PRD, feature spec, user flow, wireframe) or a pre-implementation plan.
- A search-visibility audit or marketing-page optimization.
- Committing, pushing, or publishing a finished document. The document is authored here; the version-control action that follows is a separate step.

## 5. Route Line

Before the selected mode's first phase, print one Korean line:

```text
모드: <readme|agents-md|prompt|docs|memory> / 근거: <the request phrase or file that selected it>
```

For a §2.3 boundary request, print `모드: agents-md (경계 안내만)`. For a §4 request, print the output shape and stop without loading a mode.

## Sources

> No external sources were used. Content checked 2026-11-07.

| Claim | Source |
|---|---|
| The first four modes, the selection order, and the tie-breaks | this package's design, adopted on 2026-11-07 when four single-output documentation workflows were merged into this skill by user instruction |
| The `memory` mode, its selection position ahead of `prompt`, and the memory-versus-instruction-file tie-break | user instruction, 2026-11-09 (issue 47); the mode's evidence is in `references/memory/evidence-ledger.md` |
| The prompt-versus-document rule and the prompt-in-skill-folder rule | the former prompt routing rule of this package, carried over unchanged in substance |
| The `CLAUDE.md` boundary | `rules/agents-md/mode-contract.md` (this package) |
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 468kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 197kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 197kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 197kUpdated Claude CodeCodexVerifiedInstall