Agent skill

Writing Documentation

by honeybadger-io in honeybadger-io/honeybadger-js

Guides documentation changes for honeybadger-js. An agent skill from honeybadger-io/honeybadger-js.

MITAuto-check passedDevelopment

Install Writing Documentation

skills CLI
$ npx skills add honeybadger-io/honeybadger-js --skill writing-documentation -a claude-code

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

GitHub CLI
$ gh skill install honeybadger-io/honeybadger-js writing-documentation --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/honeybadger-io/honeybadger-js.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/writing-documentation .claude/skills/writing-documentation && 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
writing-documentation
GitHub stars
116
Token cost
~389 tokens
SKILL.md length
160 words
Files
1
Skills in repo
3
Repo updated
First seen
Licence
MIT

At a glance

Guides documentation changes for honeybadger-js. An agent skill from honeybadger-io/honeybadger-js.

  • Works in 3 steps: Recommend a new GitHub issue in… → Wait for explicit human approval before… → Present the recommendation clearly so…
  • Documenting features
  • SKILL.md covers Where documentation lives, Do not document in this repo and Request a docs issue instead
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Writing Documentation is an agent skill from honeybadger-io/honeybadger-js. Guides documentation changes for honeybadger-js. Use when documenting features, updating READMEs, writing docs, or when a change needs user-facing documentation.

Its SKILL.md is about 390 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 Development, covering Technical documentation. It works with npm and JavaScript. The repository describes itself as: Universal JavaScript library for reporting errors to Honeybadger.io :zap:. The licence is MIT.

When your agent uses it

  • Documenting features
  • Updating READMEs
  • A change needs user-facing documentation

Example prompts

  • “Use the writing-documentation skill to guide documentation changes for honeybadger-js. An agent skill from honeybadger-io/honeybadger-js”
  • “/writing-documentation”

Workflow steps

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

  1. Recommend a new GitHub issue in honeybadger-io/docs with a proposed title and body describing what needs documenting. Link back to the…
  2. Wait for explicit human approval before creating the issue. Never create it unprompted.
  3. Present the recommendation clearly so the human can approve, edit, or decline.

What it can do on your machine

Read from SKILL.md and the folder at commit 4e92061. 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.

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

  • Network

    Links to these hosts (documentation or services it may open):

    • github.com
    • docs.honeybadger.io

    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

Writing Documentation loads about 389 tokens when it runs. Until then it costs about 46 tokens; SKILL.md has 160 words of instructions outside code blocks.

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

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 honeybadger-io/honeybadger-js at commit 4e92061, republished under its MIT licence (© honeybadger-io). 160 words, ~389 tokens.

Download SKILL.mdSave it as .claude/skills/writing-documentation/SKILL.md (or your agent's skills folder).
name
writing-documentation
description
Guides documentation changes for honeybadger-js. Use when documenting features, updating READMEs, writing docs, or when a change needs user-facing documentation.

Writing Documentation

Where documentation lives

All product documentation lives in the honeybadger-io/docs repository (Astro/Starlight, builds docs.honeybadger.io).

Do not document in this repo

Do not document new features or behavior changes in README.md files in honeybadger-js. Package READMEs cover installation and basic usage only.

Request a docs issue instead

When a change needs user-facing documentation:

  1. Recommend a new GitHub issue in honeybadger-io/docs with a proposed title and body describing what needs documenting. Link back to the source PR.
  2. Wait for explicit human approval before creating the issue. Never create it unprompted.
  3. Present the recommendation clearly so the human can approve, edit, or decline.
Example recommendation

Docs issue needed for the new breadcrumbsSelectorAttributes option:

  • Repo: honeybadger-io/docs
  • Title: Document breadcrumbsSelectorAttributes browser config option
  • Body: Add a section under the JS browser configuration docs describing the new breadcrumbsSelectorAttributes option, which lets users specify DOM attributes used to build legible ui.click breadcrumb selectors. Link to PR #1510.

Shall I create this issue?

© honeybadger-io, MIT. 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/writing-documentation of honeybadger-io/honeybadger-js.

Open the folder on GitHubat commit 4e92061

Compare with similar skills

Writing Documentation 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.

Writing Documentation compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Writing Documentation this skillhoneybadger-io/honeybadger-js116—~389Automated safety check: PassMIT
Sync Public DocsCaldis/react-zmage945—~3.3kAutomated safety check: PassMIT
Install Anti-Slop Oxlint Rulesdmmulroy/anti-slop5.4k—~2.2kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k1 repos~775Automated safety check: PassMIT
Update .NET Supported OS Matrixdotnet/core22k—~4.1kAutomated safety check: PassMIT
Release Roundethereumjs/ethereumjs-monorepo2.8k—~2kAutomated safety check: PassNone

Similar skills

  • Sync Public Docs

    Caldis/react-zmage

    A skill your agent uses when modifying public API in packages/core (types/global.ts, types/default.ts, index.ts, or package.json exports field), adding/renaming/removing props, changing default…

    945 GitHub stars~3.3k tokensUpdated 4 mo ago
    Agent WorkflowsAuto-check passed
  • Installs, updates or migrates the vendored anti-slop Oxlint plugin in a repository, keeping local rule changes and the plugin's license and provenance files.

    5.4k GitHub stars~2.2k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 1 repo~775 tokens
    DevelopmentAuto-check passed
  • Official

    Audits and updates the supported-os.json files for .NET releases, checking them against upstream lifecycle data and regenerating the markdown with the release-notes tool.

    22k GitHub stars~4.1k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Release Round

    ethereumjs/ethereumjs-monorepo

    Runs a coordinated EthereumJS npm release round in six human-gated phases — intent and readiness, CHANGELOG, version bump, publish (human executes), post-publish verification, and announcements.

    2.8k GitHub stars~2k tokensUpdated 22 days ago
    DevelopmentAuto-check passed
  • Ccb GitHub

    SeemSeam/claude_codex_bridge

    Maintain this CCB project's GitHub-facing release and npm publication surface.

    3.6k GitHub stars~4.9k tokensUpdated today
    DevelopmentAuto-check passed

More from honeybadger-io/honeybadger-js

  • Create Pull Request

    honeybadger-io/honeybadger-js

    Pre-submission checklist for opening pull requests in honeybadger-js.

    116 GitHub stars~275 tokensUpdated 2 days ago
    Auto-check passed
  • Review Before Commit

    honeybadger-io/honeybadger-js

    Mandatory AI code review before committing in honeybadger-js.

    116 GitHub stars~195 tokensUpdated 2 days ago
    Auto-check passed

Works with

Categories

Questions about Writing Documentation

What does Writing Documentation do?

Guides documentation changes for honeybadger-js. An agent skill from honeybadger-io/honeybadger-js. Writing Documentation is an agent skill from honeybadger-io/honeybadger-js. Guides documentation changes for honeybadger-js.

When should I use Writing Documentation?

Writing Documentation fits situations like: documenting features; updating READMEs; A change needs user-facing documentation.

How do I install Writing Documentation in Claude Code?

Run `npx skills add honeybadger-io/honeybadger-js --skill writing-documentation -a claude-code`. Or copy the skill folder (.agents/skills/writing-documentation in honeybadger-io/honeybadger-js) into .claude/skills/writing-documentation in your project. Claude Code loads it when a task matches its description.

How do I install Writing Documentation in Codex?

Run `npx skills add honeybadger-io/honeybadger-js --skill writing-documentation -a codex`. Or copy the skill folder (.agents/skills/writing-documentation in honeybadger-io/honeybadger-js) into .agents/skills/writing-documentation in your project. Codex loads it when a task matches its description.

Can I use Writing Documentation 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 honeybadger-io/honeybadger-js --skill writing-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/writing-documentation, .gemini/skills/writing-documentation, .github/skills/writing-documentation and .opencode/skills/writing-documentation in your project.

What does Writing Documentation need to run?

SKILL.md names no scripts, command-line tools or credentials: Writing Documentation is instructions for the agent only.

Does Writing Documentation access the network?

SKILL.md names 2 domains. As links in the text: github.com and docs.honeybadger.io. This is read from the text; nothing was executed.

Is Writing Documentation 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 Writing Documentation use?

Writing Documentation is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Writing Documentation use?

About 389 tokens (SKILL.md is roughly 1.6k 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 Writing Documentation?

Skills that share tags, products or a category with Writing Documentation: Sync Public Docs (Caldis/react-zmage, 945 stars), Install Anti-Slop Oxlint Rules (dmmulroy/anti-slop, 5.4k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Update .NET Supported OS Matrix (dotnet/core, 22k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Writing Documentation?

honeybadger-io (a GitHub organization) maintains it in honeybadger-io/honeybadger-js, which has 116 GitHub stars. The repository holds 3 skills in this directory. The repository was last updated on October 8, 2026.

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