Technical Writing Standard
cursor/plugins
Applies four layers of technical-writing rules to docs, RFCs, readmes, PR descriptions and commit messages so a tired engineer follows them on the first read.
Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages.
Install Heym Documentation Articles
$ npx skills add heymrun/heym --skill heym-documentation -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install heymrun/heym heym-documentation --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/heymrun/heym.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.cursor/skills/heym-documentation .claude/skills/heym-documentation && rm -rf skills-srcUse ~/.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/
Install the "heym-documentation" agent skill from https://github.com/heymrun/heym/tree/main/.cursor/skills/heym-documentation into .claude/skills/heym-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "heym-documentation", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/heymrun/heym/tree/main/.cursor/skills/heym-documentationType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add heymrun/heym --skill heym-documentation -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install heymrun/heym heym-documentation --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/heymrun/heym.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.cursor/skills/heym-documentation .agents/skills/heym-documentation && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "heym-documentation" agent skill from https://github.com/heymrun/heym/tree/main/.cursor/skills/heym-documentation into .agents/skills/heym-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "heym-documentation", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add heymrun/heym --skill heym-documentation -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install heymrun/heym heym-documentation --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/heymrun/heym.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.cursor/skills/heym-documentation .cursor/skills/heym-documentation && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "heym-documentation" agent skill from https://github.com/heymrun/heym/tree/main/.cursor/skills/heym-documentation into .cursor/skills/heym-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "heym-documentation", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/heymrun/heym.git --path .cursor/skills/heym-documentation--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add heymrun/heym --skill heym-documentation -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install heymrun/heym heym-documentation --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/heymrun/heym.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.cursor/skills/heym-documentation .gemini/skills/heym-documentation && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "heym-documentation" agent skill from https://github.com/heymrun/heym/tree/main/.cursor/skills/heym-documentation into .gemini/skills/heym-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "heym-documentation", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install heymrun/heym heym-documentationInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add heymrun/heym --skill heym-documentation -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/heymrun/heym.git skills-src && mkdir -p .github/skills && cp -r skills-src/.cursor/skills/heym-documentation .github/skills/heym-documentation && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "heym-documentation" agent skill from https://github.com/heymrun/heym/tree/main/.cursor/skills/heym-documentation into .github/skills/heym-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "heym-documentation", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add heymrun/heym --skill heym-documentation -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install heymrun/heym heym-documentation --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/heymrun/heym.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.cursor/skills/heym-documentation .opencode/skills/heym-documentation && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "heym-documentation" agent skill from https://github.com/heymrun/heym/tree/main/.cursor/skills/heym-documentation into .opencode/skills/heym-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "heym-documentation", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
heym-documentation- GitHub stars
- 1.4k
- Token cost
- ~780 tokens
- SKILL.md length
- 245 words
- Files
- 1
- Skills in repo
- 1
- Repo updated
- First seen
- Licence
- Custom licence
At a glance
Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages.
- Works in 4 steps: Choose category: getting-started, nodes,… → Pick slug: kebab-case (e.g.… → Add to manifest:… → …
- Adding a new docs page to the Heym platform from an outline
- SKILL.md covers Quick Start, File Structure, Manifest Update and Article Format, plus 3 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
For a new article, the agent picks a category among getting-started, nodes and reference, chooses a kebab-case slug, adds the item to DOCS_MANIFEST in the frontend manifest file and creates a markdown file under the content folder for that category. Manifest order drives previous and next navigation.
Articles use a single H1 with H2 and H3 sections, markdown tables for reference material, language-tagged code blocks and backticks for expressions, in a concise and scannable style with one idea per paragraph. After adding a doc, the agent scans existing content files for related mentions, wraps them in links to the new page and updates Related sections.
When your agent uses it
- Adding a new docs page to the Heym platform from an outline
- Writing a reference article from a summary
- Linking existing docs to a newly added page
Example prompts
- “Write a reference article about the expression DSL from this outline.”
- “Add a node-types page under the nodes category and update the manifest.”
- “After adding the new doc, link it from the related articles.”
Requirements
- A checkout of the Heym repository
Workflow steps
4 steps, taken from the first numbered list in SKILL.md.
- Choose category: getting-started, nodes, or reference
- Pick slug: kebab-case (e.g. expression-dsl, node-types)
- Add to manifest: frontend/src/docs/manifest.ts
- Create markdown: frontend/src/docs/content/{category}/{slug}.md
What it can do on your machine
Read from SKILL.md and the folder at commit 15a1b8c. 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
No scripts in the folder and no shell commands in SKILL.md (its code samples are typescript and markdown).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
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
Heym Documentation Articles loads about 780 tokens when it runs. Until then it costs about 52 tokens; SKILL.md has 245 words of instructions outside code blocks.
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
Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 245 words (~780 tokens).
“When creating an article from a summary or outline:”
- name
- heym-documentation
Files
Just SKILL.md in .cursor/skills/heym-documentation of heymrun/heym.
Open the folder on GitHubat commit 15a1b8c
Compare with similar skills
Heym Documentation Articles 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.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Heym Documentation Articles this skillheymrun/heym | 1.4k | — | ~780 | Automated safety check: Pass | Custom licence | |
| Technical Writing Standardcursor/plugins | 10k | 10 repos | ~2.4k | Automated safety check: Pass | None | |
| Aholo Viewer Docsmanycoretech/aholo-viewer | 1.1k | — | ~341 | Automated safety check: Pass | MIT | |
| Handsontable Docs Page Writinghandsontable/handsontable | 22k | — | ~1.1k | Automated safety check: Pass | Custom licence | |
| Landing Docs Writerlobehub/lobehub | 83k | — | ~259 | Automated safety check: Pass | Custom licence | |
| ISO 24495-3 Technical Plain LanguageGaZmagik/iso-24495 | 189 | — | ~1.6k | Automated safety check: Pass | MIT |
Similar skills
- Official
Aholo Viewer Docs
manycoretech/aholo-viewer
Guides writing and maintaining Aholo Viewer documentation: README, AGENTS.md, architecture notes, bilingual manual pages and AI collaboration guides.
Handsontable Docs Page Writing
handsontable/handsontable
Rules for writing Handsontable guide pages: required frontmatter, page structure, framework-specific example embedding, writing style and sidebar registration.
Landing Docs Writer
lobehub/lobehub
Use for public LobeHub website documentation under docs/**, including self-hosting, deployment, migration, and configuration guides. Excludes product…
ISO 24495-3 Technical Plain Language
GaZmagik/iso-24495
Applies plain language rules to software documentation, architecture explanations, code reviews and technical analysis, following the principles of ISO 24495-3:2026.
UX Writing and Docs Rules
scarletkc/agents
Judgment rules for user-facing text and docs: status output, diagnostics, error and help text, README structure, comments and titles, each backed by a real counter-example.
Related
Categories
Questions about Heym Documentation Articles
What does Heym Documentation Articles do?
Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages. For a new article, the agent picks a category among getting-started, nodes and reference, chooses a kebab-case slug, adds the item to DOCS_MANIFEST in the frontend manifest file and creates a markdown file under the content folder for that category. Manifest order drives previous and next navigation.
When should I use Heym Documentation Articles?
Heym Documentation Articles fits situations like: adding a new docs page to the Heym platform from an outline; writing a reference article from a summary; linking existing docs to a newly added page.
How do I install Heym Documentation Articles in Claude Code?
Run `npx skills add heymrun/heym --skill heym-documentation -a claude-code`. Or copy the skill folder (.cursor/skills/heym-documentation in heymrun/heym) into .claude/skills/heym-documentation in your project. Claude Code loads it when a task matches its description.
How do I install Heym Documentation Articles in Codex?
Run `npx skills add heymrun/heym --skill heym-documentation -a codex`. Or copy the skill folder (.cursor/skills/heym-documentation in heymrun/heym) into .agents/skills/heym-documentation in your project. Codex loads it when a task matches its description.
Can I use Heym Documentation Articles 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 heymrun/heym --skill heym-documentation -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/heym-documentation, .gemini/skills/heym-documentation, .github/skills/heym-documentation and .opencode/skills/heym-documentation in your project.
What does Heym Documentation Articles need to run?
SKILL.md names no scripts, command-line tools or credentials: Heym Documentation Articles is instructions for the agent only. Our summary lists: A checkout of the Heym repository.
Does Heym Documentation Articles access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Heym Documentation Articles 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 Heym Documentation Articles use?
Heym Documentation Articles has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.
How many tokens does Heym Documentation Articles use?
About 780 tokens (SKILL.md is roughly 3.1k 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 Heym Documentation Articles?
Skills that share tags, products or a category with Heym Documentation Articles: Technical Writing Standard (cursor/plugins, 10k stars), Aholo Viewer Docs (manycoretech/aholo-viewer, 1.1k stars), Handsontable Docs Page Writing (handsontable/handsontable, 22k stars) and Landing Docs Writer (lobehub/lobehub, 83k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Heym Documentation Articles?
heymrun (a GitHub organization) maintains it in heymrun/heym, which has 1,417 GitHub stars. The repository was last updated on October 7, 2026.
Source: heymrun/heym on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.