writing-github-docs

writing-github-docs is a skill for Claude Code from WangChangxin0809/repo-agent-harness. It costs 123 tokens per session (1,760 once invoked), scanned A, original, MIT.

A skill for writing a repository's public GitHub documents, including the README, contribution guide, security policy, code of conduct, licence, and issue or pull-request templates.

In plain words
What is it for?
Use it when creating or revising the files that explain a project, guide contributions, report security problems, set community expectations, or structure GitHub submissions.
Why use it?
It keeps setup instructions, contributor rules, and community policies in the right documents so visitors and contributors know what to do.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is python3 scripts/gates/check_community_health.py.

Part of the repo-agent-harness plugin — 6 skills, 1 agent, 4 hooks shipped together

Good fit Use it when creating or revising the files that explain a project…

Compare 6 skills from other repositories ↓
Install

Getting it into your agent

It runs from inside its repository, so the clone comes first — what it calls does not travel with the file alone.

Clone the repo
git clone --depth 1 https://github.com/WangChangxin0809/repo-agent-harness
agentmods
npx agentmods add skills/wangchangxin0809/repo-agent-harness/writing-github-docs

Made for: Claude Code.

Or install repo-agent-harness, the plugin that ships this one along with the rest of its 6 skills, 1 agent, 4 hooks.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for writing-github-docs

README.md
[![agentmods](https://agentmods.dev/badge/skills/wangchangxin0809/repo-agent-harness/writing-github-docs.svg)](https://agentmods.dev/skills/wangchangxin0809/repo-agent-harness/writing-github-docs)
Your own site
<a href="https://agentmods.dev/skills/wangchangxin0809/repo-agent-harness/writing-github-docs"><img src="https://agentmods.dev/badge/skills/wangchangxin0809/repo-agent-harness/writing-github-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 123 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,760 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00123 $0.01760
Opus 5 $0.00062 $0.00880
Sonnet 5 $0.00025 $0.00352
Haiku 4.5 $0.00012 $0.00176

Measured 6d ago against content hash db21ee827b18, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

writing-github-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 6d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/writing-github-docs/SKILL.md · 138 lines

How it starts

The opening of the file, as written. The whole thing — 138 lines — stays where its author put it; the contents beside it link to each section on GitHub.

The repository's public face

Three documents answering three different questions. Mixing them is the expensive mistake in this category, because the result reads complete.

File Answers Reader Failure mode
README.md What is this, and how do I run it Someone passing through Becomes a shrunken architecture document
CONTRIBUTING.md How do I take part, and what do you want Someone about to change it Becomes a second quick start
Community health Conduct, disclosure, licence, templates The platform, and outside arrivals Missing — and GitHub publishes the gap for you

Writing CONTRIBUTING as a second quick start is the standard failure. It reads fine: install the dependencies, run it, here is the directory layout. And every single thing that actually stops a contributor is absent — who reviews their pull request, how long before anyone replies, what kind of change will simply not be accepted, where to send a vulnerability. Unable to answer those, they guess, or they leave.

These files need conventions of their own

docs/ conventions are designed for someone already inside: a scope header answers "does this document cover my situation", a routing table answers "which one do I read", immutability answers "is this still current". The public face has none of those problems. Its reader has a repository URL and thirty seconds. Adding a "does not cover" section to a README applies internal governance to a problem that does not exist there.

In exchange it has a constraint docs/ does not: GitHub renders it. File name, location, and in places even heading level change what the platform does — SECURITY.md becomes the "Report a vulnerability" button, CODE_OF_CONDUCT.md appears in the community profile, .github/ISSUE_TEMPLATE/*.yml replaces the blank issue box. Getting the path wrong is not a style problem; the feature silently does not appear.

README

Ten sections. Take the content of each from a document that already exists in this repository, and note where you took it from. A section you have to invent is a document the repository is missing — record that in docs/exec-plans/tech-debt-tracker.md rather than writing plausible text.

Read the full file on GitHub · 138 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 6d ago First seen · 138 lines · 123 tokens per session scan A db21ee827b18

Subscribe to this mod's changes

writing-github-docs is a skill published in the GitHub repository WangChangxin0809/repo-agent-harness (2 stars, last pushed 7d ago), licensed MIT. It adds 123 tokens to every session and 1,760 once invoked, about $0.0006 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

doc-refresh

Orchestrates documentation updates after version bumps, feature additions, or periodic maintenance. Analyses git history since the last release, identifies which docs are affected, and delegates to existing skills (changelog, feature-benefits, docs-verify, llms-txt, user-guides) for selective refresh. Delegates AI…

littlebearapps/pitchdocs · 86 tokens

changelog

Generates user-friendly changelogs from git history using conventional commits. Writes entries in benefit language ("You can now..." not "Refactored internal..."). Follows Keep a Changelog format. Use when creating or updating CHANGELOG.md.

littlebearapps/pitchdocs · 52 tokens

platform-profiles

Platform-specific equivalents for GitLab and Bitbucket when generating repository documentation. Lookup tables for file paths, badges, Markdown rendering, CI/CD, and CLI tools. Load this skill when working on non-GitHub repos or generating cross-platform docs.

littlebearapps/pitchdocs · 53 tokens

release-expert

Multi-repo release coordination: version alignment, RC lifecycle, release waves, rollback planning. Use when saying "release", "version alignment", or "cut an RC".

anton-abyzov/specweave · 0 tokens

procoder

Work like a senior developer in a repository governed by procoder: run the commit gate before calling anything done, format and lint through the binary, and drive the spec, plan, todo, backlog, and sprint chain in .procoder/. Use this skill when the repository contains a .procoder/ directory or an AGENTS.md naming…

azrtydxb/procoder · 101 tokens

detect-task

Internal skill for commands. Detect the active task (any tracker adapter) from the task-state file / git branch name. Do not trigger on user conversation - only when commands need task detection.

restarter/lets-workflow · 41 tokens