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/readme/mode-contract.ko.md

View on GitHub
# readme 모드 계약

> 코드베이스를 읽고 쓰는 프로젝트·패키지 `README.md`의 계약, 워크플로, 게이트입니다.

**목적**: `readme` 모드를 처음부터 끝까지 책임집니다. **읽는 조건**: `rules/mode-routing.md`가 `readme`를 고른 뒤, 그 모드의 첫 단계 전에 읽습니다.

## 1. 목적

- 보일러플레이트가 아니라 실제 코드베이스에 근거한 `README.md`를 생성한다.
- 오래되거나 일반적인 README를 리팩터해 설치, 사용법, 구조, 예시가 현재 코드와 일치하도록 만든다.
- 프로젝트 형태(CLI, 라이브러리, 웹 앱, 모노레포, 플러그인, 프레임워크, 문서 사이트, 서비스)에 맞춰 섹션 선택과 깊이를 조정한다.
- 증거 보존: 모든 설치 명령, 스크립트, 배지, 예시는 저장소의 실제 파일로 추적 가능해야 한다.

## 2. 지시 계약

| 필드 | 계약 |
|---|---|
| Intent | 대상 프로젝트의 실제 형태, 설치, 사용법, 제약을 반영한 `README.md`를 생성하거나 개선한다. |
| Scope | 대상 `README.md`(루트 또는 패키지)와 짧은 요약만 소유한다. 사용자가 요청하지 않는 한 소스 코드, 설정, 라이선스, 무관한 문서는 수정하지 않는다. |
| Authority | 사용자 지시와 프로젝트 로컬 문서(`AGENTS.md`, `CLAUDE.md`, 루트 README, 패키지 매니페스트)가 일반 README 관습이나 외부 템플릿보다 우선한다. |
| Evidence | 모든 설치 명령, 스크립트 호출, 파일 경로, 배지, 기능 주장은 프로젝트의 실제 파일에 근거해야 한다. 명령이나 API를 지어내지 않는다. |
| Tools | 프로젝트 내부에서만 read/edit/write와 셸 검색(`find`, `grep`, `ls`)을 사용한다. 작성 과정에서 install, build, deploy, release 명령을 실행하지 않는다. |
| Loop | 없음. 요청 하나당 한 번만 수행한다. 프로젝트 발견, 섹션 설계, 초안 작성, 검증, 보고 후 종료하며, 다른 README나 후속 섹션 갱신을 사용자가 요청할 때만 다시 호출한다. |
| Output | 작성 또는 갱신된 단일 `README.md`와, 어떤 파일을 살폈고 어떤 섹션이 바뀌었는지 적은 짧은 요약. |
| Verification | 완료 전에 `rules/readme/validation.md`의 프로젝트 디스커버리·형태·언어·증거 검사를 실행한다. |
| Stop condition | 검사가 통과하고 불확실한 주장에 `<!-- TODO -->`가 표시되었을 때 종료한다. 프로젝트 형태가 모호하거나 라이선스가 불명확하거나 명령을 저장소에서 검증할 수 없으면 에스컬레이션한다. |

## 3. 세부 모드

| 상황 | 모드 |
|------|------|
| 프로젝트에 `README.md`가 없음 | create |
| `README.md`가 있지만 오래되거나 일반적이거나 현재 코드와 모순됨 | refactor |
| 기능, 이름 변경, 이동 후 특정 섹션을 갱신해야 함 | update |
| 모노레포 안의 하위 패키지/워크스페이스가 자체 README를 필요로 함 | create |
| README가 한국어 기본 언어 정책과 어긋나거나, 명시 요청/기존 문서 언어 보존이 필요함 | refactor |

## 4. 루프 정책

loop은 없다. 요청 하나에 프로젝트 확인, 섹션 계획, 초안, 검증, 보고를 각각 한 번씩 한다. 검사가 실패하면 지목된 섹션을 고치고 그 검사만 다시 실행하며, 이 재실행은 두 번을 넘기지 않는다. 그 뒤에도 남은 문제는 계속 반복하지 않고 그대로 보고한다. 자체 검토만으로는 검증이 되지 않는다.

## 5. 워크플로

| 단계 | 작업 | 산출물 |
|------|------|------|
| 0 | 산출물이 `README.md`인지 확인하고 `create`/`refactor`/`update`를 선택 | 모드 결정 |
| 1 | 프로젝트 구조를 스캔하고 형태를 감지(`rules/readme/project-discovery.md`) | 프로젝트 프로필 |
| 2 | 기존 README, `AGENTS.md`, `CLAUDE.md`, 라이선스, 매니페스트, 진입점 읽기 | 증거 베이스 |
| 3 | 섹션, 순서, 깊이, 한국어 기본 언어 처리 결정(`rules/readme/section-design.md`) | 섹션 플랜 |
| 4 | 근거 있는 예시와 `references/readme/readme-templates.md` / `.ko.md`의 한국어 기본 템플릿으로 `README.md` 작성/리팩터 | 갱신된 README |
| 5 | 검증 검사(`rules/readme/validation.md`) 실행 후 완료 요약 작성 | 최종 README + 요약 |

### 4단계 작성 규칙

- 먼저 읽고, 그다음 쓴다. 설치 명령, 스크립트, 환경 변수, API를 지어내지 않는다.
- README 산문은 기본적으로 한국어로 씁니다. 사용자가 다른 언어를 요청했거나 기존 대상 README의 현재 문서 언어를 보존해야 할 때만 다른 언어를 사용합니다.
- 추측 예시 세 개보다 정확한 예시 한 개를 선호한다.
- README는 스캔 가능해야 한다: 제목, 설명, 설치, 퀵스타트는 첫 화면 안에 둔다.
- 깊이 들어가는 내용은 README 밖으로 빼고 링크한다. README는 안내하는 곳이지 모든 것을 담는 곳이 아니다.
- 검증할 수 없는 배지(CI 상태, 커버리지, npm 버전)는 프로젝트가 이미 발행하고 있지 않으면 추가하지 않는다.

## 6. 필수

| 카테고리 | 필수 |
|------|------|
| Evidence | README의 모든 install/usage 라인이 매니페스트, 스크립트, 소스 파일 또는 기존 문서에 매핑된다 |
| Shape match | 섹션 선택이 감지된 프로젝트 형태와 일치한다 |
| Language match | README 산문이 기본적으로 한국어이거나, 보존이 필요한 경우 사용자 요청/기존 대상 언어와 일치한다 |
| Discoverability | 제목, 한 줄 설명, install, quickstart가 첫 화면 안에 있다 |
| Scope | update 모드에서는 사용자가 지목한 섹션이나 diff가 가리키는 섹션만 고치고, README에 변경 이력 섹션이 이미 있을 때만 항목을 추가한다 |
| Verification | 완료 선언 전에 검증 체크리스트가 끝난다 |

## 7. 금지

| 카테고리 | 금지 |
|------|------|
| Fabrication | 저장소에 없는 설치 명령, 스크립트, 환경 변수, API |
| Drift | 오래된 스크린샷, 죽은 링크, 폐기된 명령을 그대로 둠 |
| Overload | 전체 API 레퍼런스, 긴 튜토리얼, 설계 문서를 README에 끼워 넣음 |
| Tone | 마케팅 부풀림, 모호한 최상급 표현, 코드가 뒷받침하지 않는 과장 |
| Side effects | README 작성 중에 소스 코드, 설정, 라이선스를 수정 |
| Extra files | 사용자가 요청하지 않은 `CHANGELOG.md`, `CONTRIBUTING.md` 등 추가 파일 생성 |

## 8. 검증

| 검사 | 규칙 |
|------|------|
| Evidence | README의 모든 명령과 경로가 저장소에 존재 |
| Shape | 선택한 템플릿이 실제 프로젝트 형태와 일치 |
| Language | README는 기본적으로 한국어이며, 비한국어 출력은 명시 요청 또는 기존 대상 언어 보존 시에만 사용 |
| Above the fold | 제목, 설명, install, quickstart가 첫 화면 안에 위치 |
| No fabrication | 지어낸 API, 스크립트, env var, 외부 배지 없음 |
| Lean body | 긴 내용은 인라인이 아니라 링크로 처리 |
| Translation pair | 스킬 자체나 다른 마크다운을 수정했다면 영문/한글 파일이 정렬되어 있음 |

필수 통과 임계값:
- [ ] 프로젝트 형태가 감지되어 완료 요약에 기록됨
- [ ] 검증된 install 명령 1개와 검증된 usage 예시 1개 이상
- [ ] (refactor/update 모드) 정확한 기존 README 섹션은 보존됨
- [ ] 모르는 부분은 지어내지 않고 `<!-- TODO -->`로 표시됨
- [ ] 새 초안에 죽은 링크나 사라진 스크립트가 남아 있지 않음

## Sources

> 외부 출처는 사용하지 않았다. 내용 확인 2026-11-07.

| Claim | Source |
|---|---|
| 이 파일의 README 계약, 세부 모드, 워크플로, 게이트 | 이 패키지의 절차 문서. 2026-11-07에 README 워크플로를 이 스킬의 모드로 옮기면서 내용은 그대로 가져왔다 |
| 이 파일이 넘기는 조사 순서, 섹션 정책, 유형별 골격 | `rules/readme/project-discovery.md`, `rules/readme/section-design.md`, `references/readme/readme-templates.md` (이 패키지) |
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