New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Choruz Doc

by inclusionAI in inclusionAI/Choruz

Create, restructure, review, audit, or migrate Choruz Markdown documentation (docs/, README, AGENTS.md, the in-app docs pages) using one owner per fact, tier placement, executed-operation…

Apache-2.0Auto-check passedResearch & Science

Install Choruz Doc

skills CLI
$ npx skills add inclusionAI/Choruz --skill choruz-doc -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install inclusionAI/Choruz choruz-doc --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/inclusionAI/Choruz.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/choruz-doc .claude/skills/choruz-doc && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
choruz-doc
GitHub stars
1k
Token cost
~1.6k tokens
SKILL.md length
827 words
Files
1
Skills in repo
11
Repo updated
First seen
Licence
Apache-2.0

At a glance

Create, restructure, review, audit, or migrate Choruz Markdown documentation (docs/, README, AGENTS.md, the in-app docs pages) using one owner per fact, tier placement, executed-operation…

  • Works in 7 steps: Read AGENTS.md, the target page, its… → Classify the page by one job and reader:… → Place it at its nearest owner from the… → …
  • Docs-tree organisation
  • SKILL.md covers Summary, The tiers: one home per fact, Workflow and Fact-check procedure: test, do…, plus 4 more sections
  • Calls git, python3 and pnpm

What it does

Choruz Doc is an agent skill from inclusionAI/Choruz. Create, restructure, review, audit, or migrate Choruz Markdown documentation (docs/, README, AGENTS.md, the in-app docs pages) using one owner per fact, tier placement, executed-operation fact-checking, current-state prose, and the repository validators. Use for new or revised docs, docs-tree organisation, and documentation-quality audits.

Its SKILL.md is about 1.6k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Research & Science, covering Fact-checking and source verification, Agent instruction files and Technical documentation. The licence is Apache-2.0.

When your agent uses it

  • Docs-tree organisation
  • Documentation-quality audits

Example prompts

  • “/choruz-doc”

Requirements

  • Python 3

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. Read AGENTS.md, the target page, its source or tests, and the page that links to it.
  2. Classify the page by one job and reader: setup tutorial, operator procedure, architecture overview, reference, decision record, user guide.
  3. Place it at its nearest owner from the table. Keep package contracts beside the package; use docs/ for cross-package material.
  4. Define the reader's starting state, observable outcome, likely failure, recovery path and next depth before writing details.
  5. Write the common path briefly and link exhaustive truth one hop away. Each section opens with a short orienting paragraph.
  6. Verify every claim against code, tests, migrations, scripts, or package.json, and run the operations the page instructs (below).
  7. Run the validators, then re-read the whole diff once for correctness and once for brevity.

What it can do on your machine

Read from SKILL.md and the folder at commit 7509c40. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git
    • python3
    • pnpm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git and pnpm, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Choruz Doc loads about 1.6k tokens when it runs. Until then it costs about 88 tokens; SKILL.md has 827 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~88
When it runs · the whole SKILL.md, loaded when a task matches
~1.6k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from inclusionAI/Choruz at commit 7509c40, republished under its Apache-2.0 licence (© inclusionAI). 827 words, ~1,592 tokens.

Download SKILL.mdSave it as .claude/skills/choruz-doc/SKILL.md (or your agent's skills folder).
name
choruz-doc
description
Create, restructure, review, audit, or migrate Choruz Markdown documentation (docs/, README, AGENTS.md, the in-app docs pages) using one owner per fact, tier placement, executed-operation fact-checking, current-state prose, and the repository validators. Use for new or revised docs, docs-tree organisation, and documentation-quality audits.

Choruz documentation

Summary

Make every page findable, newcomer-readable, and exact enough for agents and maintainers, with one owner per fact. Apply AGENTS.md and the gates first, then this workflow for placement, progressive detail, fact-checking, and validation. Design rationale lives in Agent Notes; this skill owns everything else written for a human or agent reader.

The tiers: one home per fact

TierHomeHoldsNot
Standing ordersAGENTS.mdOne to three lines per rule, linking its homeRationale, procedures
Platform protocolCLAUDE.mdHow an agent talks to humans and agents on ChoruzEngineering rules
Architecturedocs/architecture.mdThe ordered map of how the system works todayPer-crate detail, history, status
Data modeldocs/data-model.mdTables, ownership, workspace_id, sequencesMigration narration
Operationsdocs/operations/Install, run, deploy, back up, SLO, runbookDesign rationale
Testingdocs/testing/PR types, what CI runs, e2e conventionsTest walkthroughs
Decisions.agents/notes/Problem, decision, alternatives, consequencesCurrent-state reference
Contributor entryCONTRIBUTING.md, README.mdSetup, commands, layout, links into the tiersDuplicated rules
User docsapps/web/app/docs/The in-app documentation siteEngineering process
Package contractsa package's README.md, doc commentsConfig, semantics, failures, limitationsCross-package narrative

Placement: bugs and incidents to a note or a runbook; rationale to notes; procedures to operations; type and table definitions to the data model; package contracts to the package README; standing orders to AGENTS.md with a link.

Workflow

  1. Read AGENTS.md, the target page, its source or tests, and the page that links to it.
  2. Classify the page by one job and reader: setup tutorial, operator procedure, architecture overview, reference, decision record, user guide.
  3. Place it at its nearest owner from the table. Keep package contracts beside the package; use docs/ for cross-package material.
  4. Define the reader's starting state, observable outcome, likely failure, recovery path and next depth before writing details.
  5. Write the common path briefly and link exhaustive truth one hop away. Each section opens with a short orienting paragraph.
  6. Verify every claim against code, tests, migrations, scripts, or package.json, and run the operations the page instructs (below).
  7. Run the validators, then re-read the whole diff once for correctness and once for brevity.

Fact-check procedure: test, do not assume

The only admissible evidence for an operation claim is having run it.

  1. Run every claimed command against the current checkout, exactly as the page will show it; write down only what you observed, including warnings and failure modes. pnpm scripts come from package.json; a documented flag must exist in the binary's --help.
  2. Delete what you could not reproduce. Never carry a command, field, default or behaviour from memory or from a neighbouring page. When a claim fails to reproduce, fix the claim.
  3. Check old pages against origin/main before revising them; a stale statement on main is still wrong and is corrected against the code, not against the old prose.
  4. Environment variables are named from their reading site (git grep CHORUZ_ over infra/, services/, apps/), with the default the code applies.
Show full SKILL.md (335 more words)Show less

Voice rules

  • Summary says what the subject does for the reader (outcomes, when to choose it, main cost), never its role or internal identity.
  • Reference sections explain, never enumerate what a generated or source artifact already lists; link the source for exact detail.
  • Current state only. No "previously", "now", "no longer", PR numbers or migration narration outside notes' Consequences.
  • Controlled technical English: one actor and one main action per sentence where ambiguity could change behaviour; one term per concept; direct verbs; preserve modality and exceptions. Chinese is welcome in README.md and user-facing pages where the existing page is Chinese; keep a page in one language.
  • Link by relative path, never by bare filename or note number.

Quality criteria

  • Brief: the common path contains only facts needed for its outcome.
  • Intuitive: prerequisites precede dependent concepts; one next action is obvious; headings use terms readers search for.
  • Friendly: readers can recognise success, understand risk before acting, and recover from likely failure.
  • Accurate: each durable claim has one owner and a verification path.
  • Agent-readable: stable headings, anchors, terminology and ownership support targeted retrieval.
  • Newcomer-complete: an engineer with no repository context can reconstruct the relevant architecture through three to five linked pages.

Audit the corpus

Hunt the slop list with the cheapest probes first: git grep distinctive phrases to find duplicated rules; find hand-written inventories that a script or the tree already owns; find migration plans and future-tense spec language in implemented notes; find "previously/now/no longer". Keep every load-bearing rule, preferably as one to three lines plus a link to its rationale.

Validation

  • Links: every relative link resolves; check the targets or open the page in the rendered preview.
  • Agent Notes: python3 scripts/verify_agent_notes.py.
  • Commands: re-run every command the page instructs before merging a claim about it.
  • Web docs pages (apps/web/app/docs): pnpm web:check, and the docs e2e spec when the page structure changed.
  • A docs-only pull request runs no test job and merges in seconds; do not mix a config or code change into it.

Use choruz-prose-standard for sentence-level judgement.

© inclusionAI, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/choruz-doc of inclusionAI/Choruz.

Open the folder on GitHubat commit 7509c40

Compare with similar skills

Choruz Doc next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Choruz Doc compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Choruz Doc this skillinclusionAI/Choruz1k—~1.6kAutomated safety check: PassApache-2.0
Review DocsKaggle/kaggle-environments455—~2.7kAutomated safety check: PassApache-2.0
Alego Docsingula-ai/alego1091 repos~4.5kAutomated safety check: PassMIT
Export TemplateHurricaHjz/second-yourself123—~4.8kAutomated safety check: WarnMIT
Neat-Freak Knowledge CloseoutKKKKhazix/khazix-skills21k—~1.9kAutomated safety check: PassMIT
Dsh Web Documentationzhu1090093659/dsh-web8.6k—~479Automated safety check: PassApache-2.0

Similar skills

  • Review Docs

    Kaggle/kaggle-environments

    Audit a game environment's README.md and AGENTS.md against its engine implementation.

    455 GitHub stars~2.7k tokensUpdated yesterday
    Agent WorkflowsAuto-check passed

  • Alego Doc

    singula-ai/alego

    Create, restructure, review, audit, or migrate Alego Markdown documentation, package READMEs, and the documentation website using audience-first hierarchy, kind-mapped YAML metadata, bilingual line…

    109 GitHub starsUsed in 1 repo~4.5k tokens
    Research & ScienceAuto-check passed

  • Export Template

    HurricaHjz/second-yourself

    Sync THIS LLM-Wiki framework with its public GitHub repo, ONE direction per run: --push (vault → repo) publishes your framework; --pull (repo → vault) updates your framework from a newer repo version.

    123 GitHub stars~4.8k tokensUpdated 9 days ago
    Knowledge ManagementAuto-check: warnings

  • Neat-Freak Knowledge Closeout

    KKKKhazix/khazix-skills

    Brings project docs, agent rule files, authorized memory and leftover workspace files back in line with what the code and runtime actually do at the end of a work session.

    21k GitHub stars~1.9k tokensUpdated 9 days ago
    Agent WorkflowsAuto-check passed

  • Dsh Web Documentation

    zhu1090093659/dsh-web

    A skill your agent uses when adding or editing dsh-web README files, docs, AGENTS.md instructions, user-facing configuration text, or bilingual documentation pairs.

    8.6k GitHub stars~479 tokensUpdated today
    Agent WorkflowsAuto-check passed

  • Claude Docs Consultant

    centminmod/my-claude-code-setup

    Consult official Claude Code documentation from code.claude.com using selective fetching.

    2.7k GitHub stars~959 tokensUpdated 2 days ago
    Agent WorkflowsAuto-check passed

More from inclusionAI/Choruz

All 11 skills in this repo

  • Choruz Archive Agent Notes

    inclusionAI/Choruz

    A skill your agent uses when adding, auditing, pruning, archiving, restoring, or reviewing Agent Notes in this repository; checks every new note for superseded active records, classifies implemented…

    1k GitHub stars~1.2k tokensUpdated 3 days ago
    Auto-check passed

  • Choruz Merging Stacked PRs

    inclusionAI/Choruz

    A skill your agent uses when landing a chain of dependent pull requests (A ← B ← C, each based on the one below) onto main, merging a PR whose base is another open PR's branch, or whenever a request…

    1k GitHub stars~866 tokensUpdated 3 days ago
    Auto-check passed

  • Choruz CI Test Reliability

    inclusionAI/Choruz

    Design, review, and diagnose Choruz tests and fixtures that can fail nondeterministically under CI concurrency: parallel Playwright workers sharing one PostgreSQL and one API, vitest workers, cargo…

    1k GitHub stars~1.8k tokensUpdated 3 days ago
    Auto-check passed

  • Choruz Code Review

    inclusionAI/Choruz

    A skill your agent uses when reviewing a pull request in this repository; orients the reviewer to Choruz's standards (AGENTS.md conventions, the PR test policy, Agent Notes, the CI gates) and the…

    1k GitHub stars~1.7k tokensUpdated 3 days ago
    Auto-check passed

  • Choruz Find Simplifications

    inclusionAI/Choruz

    A skill your agent uses when working in this repository to find non-obvious simplification candidates, remove redundant comments or implementation-heavy documentation, write proposed Agent Notes or…

    1k GitHub stars~1.6k tokensUpdated 3 days ago
    Auto-check passed

  • Choruz PR

    inclusionAI/Choruz

    Use before opening or completing a pull request in this repository — classify the change, add the tests its type requires, run exactly what CI will run, label it, merge only on a green "CI (linux)…

    1k GitHub stars~2.6k tokensUpdated 3 days ago
    Auto-check passed

Categories

Questions about Choruz Doc

What does Choruz Doc do?

Create, restructure, review, audit, or migrate Choruz Markdown documentation (docs/, README, AGENTS.md, the in-app docs pages) using one owner per fact, tier placement, executed-operation…. Choruz Doc is an agent skill from inclusionAI/Choruz.md, the in-app docs pages) using one owner per fact, tier placement, executed-operation fact-checking, current-state prose, and the repository validators.

When should I use Choruz Doc?

Choruz Doc fits situations like: docs-tree organisation; documentation-quality audits.

How do I install Choruz Doc in Claude Code?

Run `npx skills add inclusionAI/Choruz --skill choruz-doc -a claude-code`. Or copy the skill folder (.agents/skills/choruz-doc in inclusionAI/Choruz) into .claude/skills/choruz-doc in your project. Claude Code loads it when a task matches its description.

How do I install Choruz Doc in Codex?

Run `npx skills add inclusionAI/Choruz --skill choruz-doc -a codex`. Or copy the skill folder (.agents/skills/choruz-doc in inclusionAI/Choruz) into .agents/skills/choruz-doc in your project. Codex loads it when a task matches its description.

Can I use Choruz Doc in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add inclusionAI/Choruz --skill choruz-doc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/choruz-doc, .gemini/skills/choruz-doc, .github/skills/choruz-doc and .opencode/skills/choruz-doc in your project.

What does Choruz Doc need to run?

Going by SKILL.md and its folder, Choruz Doc needs the command-line tools its instructions call (git, python3 and pnpm). Our summary lists: Python 3.

Does Choruz Doc access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Choruz Doc safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Choruz Doc use?

Choruz Doc is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Choruz Doc use?

About 1.6k tokens (SKILL.md is roughly 6.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Choruz Doc?

Skills that share tags, products or a category with Choruz Doc: Review Docs (Kaggle/kaggle-environments, 455 stars), Alego Doc (singula-ai/alego, 109 stars), Export Template (HurricaHjz/second-yourself, 123 stars) and Neat-Freak Knowledge Closeout (KKKKhazix/khazix-skills, 21k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Choruz Doc?

inclusionAI (a GitHub organization) maintains it in inclusionAI/Choruz, which has 1,017 GitHub stars. The repository holds 11 skills in this directory. The repository was last updated on October 7, 2026.

Source: inclusionAI/Choruz on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.