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.
rules/readme/validation.md
View on GitHub# README Validation
**Purpose**: Quality gates before declaring the README done.
## Evidence checks
- [ ] Every install command appears in the repo's manifest, lockfile, or existing docs.
- [ ] Every script invocation (`npm run build`, `cargo test`, `pnpm dev`, etc.) exists in the actual scripts/tasks file.
- [ ] Every command in the CLI section maps to an actual command handler in source.
- [ ] Every API or exported symbol in the usage section is exported from the entry point.
- [ ] Every file path mentioned exists in the repo.
- [ ] Every linked URL points to a real local file or a documented external resource.
## Shape checks
- [ ] Project type is recorded in the discovery profile.
- [ ] Section selection matches the type policy in `rules/readme/section-design.md`.
- [ ] Order follows the default unless the project explicitly uses another.
- [ ] Quickstart is reachable within the first screen on a typical viewport.
- [ ] Project structure section is included only when non-trivial.
## Language checks
- [ ] README prose is Korean by default, or uses another language only because the user requested it or an existing target README required preservation.
- [ ] Terminology matches the codebase (folder, command, and config names are exact).
- [ ] No marketing fluff; capability is stated, not exaggerated.
- [ ] Sentence-case or Title-case headings are used consistently.
## Anti-fabrication checks
- [ ] No invented commands, scripts, env vars, or APIs.
- [ ] No badges without a real source.
- [ ] No screenshots referenced without a real file.
- [ ] Unknowns are marked with `<!-- TODO -->` or an explicit "verify with maintainer" note.
## Refactor-mode checks
- [ ] Existing accurate sections are preserved.
- [ ] Stale commands and dead links are removed or replaced.
- [ ] Diff against the prior README is small enough to review.
## Update-mode checks
- [ ] Only the requested or implied sections were touched.
- [ ] Surrounding sections were left intact.
- [ ] If a change-history section already exists, a dated entry was appended.
## Completion summary
Report the following at the end:
```text
Mode: [create | refactor | update]
Project type: [cli | library | web-app | monorepo | plugin | framework | docs-site | service]
Files inspected: [list of paths actually read]
Sections changed: [list of headings created or rewritten]
Unknowns flagged: [count + locations of <!-- TODO --> markers]
```
If any check fails, fix the README rather than relaxing the check.
## Sources
> No external sources; content checked 2026-09-21.
This rule states the repository-local validation gates for README authoring. It makes no external claim, so no external source is cited.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| 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: 467k | Updated | Claude CodeCodex | Verified | Install |
| 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: 196k | Updated | Claude CodeCodex | Verified | Install |
| 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: 196k | Updated | Claude CodeCodex | Unverified | Install |
| 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: 196k | Updated | Claude CodeCodex | Verified | Install |