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.mdmarkdown20.9 KB
SKILL.mdskill md19.1 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/readme/section-design.md

View on GitHub
# Section Design

**Purpose**: Choose README sections, order, depth, and language from the project profile.

## 1. Section policy by project type

| Type | Required | Recommended | Skip unless asked |
|---|---|---|---|
| **CLI** | Title, install, quickstart, commands, examples, license | Configuration, environment variables, exit codes | Architecture diagrams, internal API |
| **Library** | Title, install, usage, API surface, examples, license | TypeScript types, peer deps, supported runtimes | Internal module map |
| **Web app** | Title, dev quickstart, environment, build/deploy, license | Tech stack, project structure, contributing | Marketing copy |
| **Monorepo** | Title, repo overview, package list, dev quickstart, license | Per-package READMEs, shared scripts | Long architecture essays |
| **Plugin** | Title, install (host platform), usage, configuration, license | Compatibility matrix, examples per host | Internal extension points |
| **Framework** | Title, install (`create-*`), quickstart, core concepts (linked), license | Templates, ecosystem | Full doc site contents |
| **Docs site** | Title, what it documents, local dev, contribution flow, license | Build/deploy, content structure | Generated content trees |
| **Service / API** | Title, run locally, environment, endpoints summary, license | Deployment, observability | Internal request handlers |

When multiple types apply, pick the dominant one and add only the extra section a secondary type genuinely requires.

## 2. Order conventions

Default order, top to bottom:

1. Title + one-line description
2. Badges (only when verifiable)
3. Features (3-7 bullets max, one line each)
4. Install
5. Quickstart / Usage
6. Configuration / Environment
7. Commands / API surface
8. Examples (use collapsed `<details>` if long)
9. Development (scripts, test, lint)
10. Project structure (only when non-trivial)
11. Contributing (only if a process is documented)
12. License

Do not bury install. New readers should reach the install command without scrolling past long context.

## 3. Heading and code style

- Use sentence case for headings unless project docs already use Title Case throughout.
- Use fenced code blocks with the right language tag (`bash`, `ts`, `py`, `rs`, `json`, `yaml`).
- Show shell prompts only when copying from a transcript (`$` for user, `#` for root). Otherwise omit.
- Keep example code under ~12 lines per block; link to a longer example file if needed.
- Use the same casing the codebase uses for command names, folder names, and config keys.

## 4. Language and tone

- Write README prose in Korean by default. Use another language only when the user explicitly requests it or when an existing target README must preserve its current language for consistency.
- Use the same terminology the codebase uses (folder names, command names, config keys are quoted exactly).
- State capability over marketing: "Renders Mermaid diagrams to SVG without dependencies" beats "blazing-fast diagram engine".
- Use one term per concept across the README.
- Keep sentences short. Prefer lists and tables over paragraphs when content is enumerable.

## 5. Badges

Add badges only when:

- the badge source is real (a published npm version, a configured CI workflow, a registered SPDX license), and
- the project already publishes them or the user explicitly asks for them.

Do not add coverage, downloads, or build-status badges if no source can be linked. A missing badge is better than a broken one.

## 6. Quickstart contract

The quickstart should:

- be runnable end to end after install,
- use the smallest realistic example,
- avoid placeholder values (`YOUR_TOKEN`, `<replace-me>`) when a default works,
- prefer a single command or 3-5 lines of code over a long walkthrough.

If the project genuinely needs setup (env vars, accounts, external services), state it in one short paragraph and link to the deeper guide.

## 7. Section trimming

Drop sections that have no real content:

- No tests configured -> skip "Testing".
- No published package -> skip "Install from registry"; keep "From source" only.
- No contributing process documented -> use a short link to the issue tracker instead of fabricating one.
- No deploy pipeline documented -> skip "Deployment" rather than guessing.

A short, accurate README beats a long padded one.

## 8. Monorepo-specific guidance

For monorepos, the root README orients readers across packages; per-package READMEs go deep on a single package.

- Root README: list packages with one-line purpose and folder path; show the workspace-aware install/dev command at the root.
- Package README: treat the package as its own project and apply the matching type policy from the table above.
- Avoid duplicating per-package install instructions in the root README; link instead.

## Sources

> No external sources; content checked 2026-09-21.

This rule states the repository-local section-design policy for README authoring. It makes no external claim, so no external 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: 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