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.
references/readme/readme-templates.md
View on GitHub# README Templates
**Purpose**: Ready-to-use section skeletons by project type. Copy the matching block, then replace placeholders with verified evidence from the project.
> All templates below are written in English. Translate headings and prose into Korean by default; keep code blocks intact. Use another language only when the user explicitly requests it or an existing target README must preserve its current language.
## Contents
- CLI
- Library
- Web app
- Monorepo
- Plugin
- Framework
- Docs site
- Service / API
- Notes on placeholders
- Sources
## CLI
```markdown
# <name>
> <one-line description>
## Install
\`\`\`bash
<package-manager-install>
\`\`\`
## Quickstart
\`\`\`bash
<name> <subcommand> [options]
\`\`\`
## Commands
| Command | Description |
|---|---|
| `<name> <cmd>` | <what it does> |
## Configuration
- `<env var>` — <purpose, default>
## Examples
\`\`\`bash
<realistic example>
\`\`\`
## Development
\`\`\`bash
<dev script>
<test script>
\`\`\`
## License
<SPDX or text>
```
## Library
```markdown
# <name>
> <one-line description>
## Install
\`\`\`bash
<install from registry>
\`\`\`
## Usage
\`\`\`ts
import { <api> } from "<name>";
<small realistic example>
\`\`\`
## API
- `<exportedName>(args)` — <what it returns>
## Compatibility
- Node: <range>
- Browsers: <if applicable>
## Development
\`\`\`bash
<dev/test scripts>
\`\`\`
## License
<SPDX or text>
```
## Web app
```markdown
# <name>
> <one-line description>
## Stack
- <framework + version>
- <database / state / styling>
## Local development
\`\`\`bash
<install>
<dev>
\`\`\`
The app runs at <url>.
## Environment
| Variable | Required | Description |
|---|---|---|
| `<KEY>` | yes/no | <purpose> |
## Build and deploy
\`\`\`bash
<build>
<start>
\`\`\`
## Project structure
\`\`\`text
<key folders only>
\`\`\`
## License
<SPDX or text>
```
## Monorepo
```markdown
# <repo name>
> <one-line description>
## Packages
| Package | Purpose | Path |
|---|---|---|
| `<pkg>` | <purpose> | `packages/<pkg>` |
## Local development
\`\`\`bash
<install at root>
<workspace-aware dev/test command>
\`\`\`
## Contributing
See per-package READMEs for package-specific docs.
## License
<SPDX or text>
```
## Plugin
```markdown
# <name>
> <one-line description>
## Compatibility
- <host platforms supported>
## Install
\`\`\`text
<host-platform install command derived from project's own docs>
\`\`\`
## Usage
<how to invoke the plugin in the host environment>
## Configuration
<config options derived from the manifest>
## License
<SPDX or text>
```
## Framework
```markdown
# <name>
> <one-line description>
## Quickstart
\`\`\`bash
<create command>
\`\`\`
## Core concepts
- <concept> — <one-line explanation> (link to deeper doc)
## Templates / starters
| Template | Description |
|---|---|
| `<template>` | <purpose> |
## Documentation
<link to docs site or docs folder>
## License
<SPDX or text>
```
## Docs site
```markdown
# <name>
> <one-line description>
## Local development
\`\`\`bash
<install>
<dev>
\`\`\`
## Content structure
- `<folder>/` — <what it documents>
## Build and deploy
\`\`\`bash
<build>
\`\`\`
## Contributing
<short note + link to contribution guide>
## License
<SPDX or text>
```
## Service / API
```markdown
# <name>
> <one-line description>
## Run locally
\`\`\`bash
<install>
<run>
\`\`\`
## Environment
| Variable | Required | Description |
|---|---|---|
| `<KEY>` | yes/no | <purpose> |
## Endpoints
| Method | Path | Description |
|---|---|---|
| GET | `/health` | health probe |
## Deployment
<short note or link>
## License
<SPDX or text>
```
## Notes on placeholders
- Replace every `<placeholder>` with a value verified from the repo.
- Drop entire sections that the project does not support (no tests, no env vars, no published package).
- Keep at most one example per section unless the project genuinely has distinct flows worth showing separately.
## Sources
> No external sources; content checked 2026-09-21.
These templates are repository-authored skeletons derived from the section policy in `rules/readme/section-design.md`. They make 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: 470k | 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: 197k | 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: 197k | 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: 197k | Updated | Claude CodeCodex | Verified | Install |