prose-writing
GitHub面向所有用户可见文本的写作风格指南，涵盖GitHub交互、文档、营销文案及聊天回复。核心原则为事实、中立、简洁、易读，禁止冗余与过度承诺，确保内容适合快速浏览。
触发场景
安装
npx skills add nubjs/nub --skill prose-writing -g -y
SKILL.md
Frontmatter
{
"name": "prose-writing",
"description": "Copywriting \/ prose \/ tone style guide for EVERY user-facing or public-facing text artifact. INVOKE THIS SKILL (via the Skill tool) BEFORE you write or edit ANY of the following — and if you are a SUB-AGENT instructed to do any of them, invoke it yourself first; the agent that writes the copy loads this skill, the orchestrator does not load it on a sub-agent's behalf: (1) ANY GitHub-facing text — before running `gh issue comment`, `gh pr comment`, `gh pr create` \/ any `--body`, `gh issue close --comment`, `gh pr review` \/ `gh pr comment` review notes, or `gh release create` \/ `gh release edit --notes`; i.e. any issue reply or comment, PR description\/body, issue-close note, code-review comment, or release notes. (2) ANY documentation — creating or editing a file under `site\/content\/docs\/**` or `site\/content\/blog\/**`, `README.md`, `CHANGELOG`, `wiki\/**` user-facing pages, or any `.md` \/ `.mdx` that ships to users. (3) Marketing \/ homepage \/ blog copy, a `package.json` or npm `description`, or any other description\/summary field. (4) Whenever you APPLY a general copy-style correction — sweep it everywhere it applies, not just the one spot it was raised, and record it in PROSE.md. (5) A substantive prose chat reply. (6) Reformatting or structuring existing copy for scannability — breaking up a wall of text, or converting a run of paragraphs into a list, table, or callout. A bold-sentence lead-in does NOT count as a block-level break: a run of bold-led paragraphs is still a wall of text, and the fix is a real list\/table\/ callout, never bolding the first sentence of each paragraph. Through-line: factual, neutral, terse, scannable — never two-plus dense paragraphs in a row without a block-level element; state what's true, cut everything that doesn't add a fact, build for a reader who skims. Encodes GitHub maintainer-hygiene tone, sentence\/heading mechanics (never open a sentence or heading with inline code), scannability, honesty\/restraint, release-notes + marquee-announcement + migration-entry shape, markdown mechanics (never hard-wrap paragraphs), and the universal tone rules. Canonical full guide: PROSE.md at the repo root (this skill is its trigger + index). Project-specific copy rules (brand vocabulary, claim-tracing, product framing) live in AGENTS.md, layered on top."
}
prose-writing
The canonical guide is PROSE.md at the repo root — read it. This skill exists to make that guide auto-surface whenever copy is being written, and to index it. PROSE.md is the single source of truth; do not duplicate its content elsewhere, and when a general copy rule is added or corrected, update PROSE.md (then sweep every doc/page it applies to).
When this applies
Any user-facing text: a GitHub issue/PR comment, a docs page (site/content/docs/**), blog/marketing/homepage copy, release notes, a package/PR description field, or a chat reply. Also whenever you receive a general copy-style correction — apply it everywhere it's relevant, not only at the spot it was raised, and record it in PROSE.md.
The agent that WRITES the copy loads this skill — not the orchestrator on its behalf. If you are delegating copy work (a sub-agent that will post an issue/PR comment, write a PR body, close an issue, edit docs, or draft release notes), put "load the prose skill before writing" in that sub-agent's prompt. The orchestrator loads this skill only for copy it writes in its OWN turn (a chat reply, a control-surface edit). Comment / PR-body / docs / release-notes writing is delegable — delegate it, and the writer loads the skill.
What's in PROSE.md (read the relevant section before writing)
- GitHub issues & PRs — factual/neutral/professional tone, no niceties or preamble; acknowledge an external report the moment you start; never reply to a bot as if human;
Closes #N/Fixes #Nin a fix-PR body (Refs #Nif it only relates); close issues with a brief factual comment, never silently; on release, comment the version + link on every shipped issue/PR. - Public-facing docs — terse, code-first, no marketing fluff; show the thing working. Sentence/heading mechanics (never start a sentence or heading with inline code or a command), structure & density, honesty & restraint, description-field rules.
- Blog & marketing — open with the thing working; code blocks carry the argument; no walls of text; benchmarks as visuals; protective-refusals shown with real output; asides sparing.
- Markdown mechanics — never hard-wrap paragraphs; scannable over dense; release-notes shape; marquee-announcement shape (narrative arc, perf-multiplier framing, named attribution, signed milestone posts); migration / breaking-change entry shape.
- Naming & capitalization, and the universal tone rules (apply to every surface above).
The through-line (if you read nothing else)
Factual, neutral, terse, scannable. State what is true; cut everything that does not add a fact. Never braggy, competitive, hyped, or over-promising. Build for a reader who skims. Then open PROSE.md for the specifics of the surface you're writing.
版本历史
- 44d0dd0 当前 2026-07-05 11:03
