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/agents-md/rule-file-splitting.md

View on GitHub
# Rule File Splitting

**Purpose**: Keep a governing `AGENTS.md` lean by moving same-scope detail into an adjacent `rules/` directory without hiding instructions that must always load.

## 1. When to Split

Use this rule when an existing or drafted `AGENTS.md` is becoming hard to scan, consumes too much of the combined instruction budget, or contains detailed procedures that apply only to some tasks.

Apply these decisions in order:

1. Delete generic, discoverable, stale, duplicated, or non-load-bearing text.
2. Move genuine subtree differences to the closest justified nested `AGENTS.md`.
3. Keep always-needed scope, authority, commands, safety gates, and stop conditions in the governing `AGENTS.md`.
4. Move only same-scope, conditionally needed detail to `rules/*.md` beside that `AGENTS.md`.

A `rules/` split is progressive disclosure, not a way to preserve everything that failed the admission test.

## 2. Placement and Shape

For a root instruction file:

```text
repository/
├── AGENTS.md
├── AGENTS.ko.md
└── rules/
    ├── architecture.md
    ├── architecture.ko.md
    ├── testing.md
    └── testing.ko.md
```

For a nested instruction file, place its support rules beside it in that subtree only when the rules govern the same subtree. Reuse an existing adjacent `rules/` directory only when it already holds instruction documentation and the new names cannot collide. Do not mix agent-policy Markdown into a directory used for product code, generated files, or another established purpose; use the repository's existing instruction-doc location instead and link it directly.

Use descriptive kebab-case names based on the decision surface, such as `architecture-boundaries.md`, `testing.md`, or `release-safety.md`. Do not create catch-all files such as `misc.md`.

## 3. Loading Contract

Arbitrary `rules/*.md` files are not assumed to be runtime-discovered or automatically imported. The governing `AGENTS.md` must link every support file directly and state exactly when to read it.

Good:

```markdown
## Conditional rules

- Read `rules/testing.md` before changing test infrastructure or test commands.
- Read `rules/architecture-boundaries.md` before moving code across package boundaries.
```

Each entry is one Markdown link to the support file plus the condition that triggers reading it. The paths above are example paths inside a target repository, so they appear here as code spans instead of links that would not resolve from this package.

Do not use vague cues such as “see `rules/`.” Do not use runtime-specific import syntax in shared `AGENTS.md` unless the target runtime and syntax were explicitly verified. A plain Markdown link plus a read condition is the portable default.

Because linked files are conditional context, never move essential scope, authority, safety, required commands, or completion gates out of `AGENTS.md`. The core must remain safe and actionable when no support rule has been opened yet.

## 4. Canonical Ownership

Each rule has one canonical home:

| Content | Home |
|---|---|
| Always-needed repository contract | Governing `AGENTS.md` |
| Subtree-specific delta | Closest justified nested `AGENTS.md` |
| Same-scope detailed policy or procedure used only for matching tasks | Adjacent `rules/*.md` |
| Detailed architecture or API knowledge already maintained elsewhere | Existing project documentation, linked directly |
| Deterministic enforcement | Hook, CI, lint rule, schema, or executable configuration |

Do not summarize a support rule back into the core beyond the minimum routing cue. Do not create support files that merely repeat root or nested instructions.

## 5. Language Pairing

Write agent-loaded rule files in the same language as the governing `AGENTS.md`. When the root `AGENTS.md` uses this skill's default English-plus-Korean-mirror contract, pair each created or materially changed `rules/name.md` with `rules/name.ko.md`. Links in `AGENTS.md` point to the English files; links in `AGENTS.ko.md` point to the Korean mirrors.

A nested rule mirror follows the same policy selected for its governing nested `AGENTS.md`. Preserve commands, paths, identifiers, and modal strength across translations.

## 6. Validation Gate

- [ ] Deletion and nested placement were considered before creating support rules.
- [ ] The `rules/` directory is adjacent to the governing `AGENTS.md` or an existing documented instruction location is used instead.
- [ ] Every support file has one responsibility, a direct link, and an explicit read condition.
- [ ] No essential always-loaded contract moved out of `AGENTS.md`.
- [ ] No support rule duplicates root, nested, or existing project documentation.
- [ ] Existing non-documentation `rules/` content was not overwritten or mixed with agent policy.
- [ ] English/Korean links resolve to semantically aligned files when mirrors are required.
- [ ] Root plus applicable nested instruction files still leave headroom under the configured runtime budget.

## Sources

> Links checked 2026-09-21. No external source was used in this file.

| Claim | Source |
|---|---|
| The split, placement, loading, ownership, and language rules in this file | the repository skill-authoring standard under `instructions/skill/` and this package's `SKILL.md`; no vendor or web source is cited |
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: 469kUpdated 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