Index of every page on this site: llms.txt
All skills
tristanmanchester avatar

/write-good-docs

@3323bc9
by Tristan Manchestertristanmanchester/agent-skills3 stars
2
Run it yourself

Write, edit, and review human-facing technical documentation. Use for READMEs, guides, tutorials, how-tos, API or CLI reference, runbooks, troubleshooting, onboarding, architecture and design docs, RFCs, ADRs, migration guides, release notes, technical findings reports, docstrings, and explanatory comments. Also use for requests such as "document this" or "make this guide clearer." Do not automatically activate for chat explanations, email, marketing, social posts, fiction, translation-only tasks, or code-only work. When explicitly asked to use this skill for another nonfiction format, apply its prose and fidelity guidance without imposing documentation templates.

Use this Skill: https://skilld.dev/gh/tristanmanchester/agent-skills/write-good-docs

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencessource-map.md

≈2k tokens on demand. Your agent reads this file only when SKILL.md points to it.

Official source map

Use this map when a condensed rule does not settle an edge case or when a live rule, product name, lifecycle term, or word-list entry might have changed. Prefer project-specific guidance before the general guide.

The inherited source inventory below comes from the v2.0.0 research snapshot of August 18, 2026. Sources material to this revision were selectively rechecked on September 13, 2026; this is not a new audit of every inherited link. Style sources establish conventions, not product facts or empirical evidence that this skill improves output.

Sources checked for version 2.1

Source Use in this revision
Google guide philosophy Distinguish house style from universal correctness
Google active voice Preserve useful passive constructions and reader focus
Google voice and tone Avoid choppy sentences and use meaningful connections
Google word list Correct the definition of deprecated
Diátaxis and colophon Acknowledge the four document needs and creator
Agent Skills specification Keep portable metadata and conditional references
Skill creator best practices Limit unnecessary reference loading and inspect real usage
Evaluating skill output quality Separate fixtures, output comparisons, assertions, and reviewer judgments
Anthropic prompting guidance Use relevant, diverse examples and positive output instructions

The evidence-preserving workflow, prose examples, evaluation gates, and maintenance scripts are package-specific implementations. Their effect on generated writing still needs controlled comparison.

Agent Skills design

Google guide introduction

Key resources

General principles

Language and grammar

Punctuation

Formatting and organization

Linking

Computer interfaces

HTML and CSS

Names and naming

External editorial fallbacks named by the guide

Source: SKILL.md on GitHub

Skill behaviors

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

Third-party checks

1 warning1mo3 checks · Risk SAFE
  • Gen Agent Trust Hub1mo

    The skill is a high-quality documentation assistant based on the Google developer documentation style guide. It incorporates robust safety practices, explicitly prohibiting the inclusion of sensitive data like credentials in examples and prioritising technical accuracy. All external links are to trusted and well-known documentation platforms.

  • Socket1mo

    No alerts

  • Snyk1mo

    Risk: MEDIUM · 1 issue

Provenance

Signed by skilld at 3323bc9. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 weeks ago.

Steadyupdated last month

Capability

Other metadata
metadata
{
  "version": "2.1.0",
  "source": "Google developer documentation style guide; see ATTRIBUTION.md",
  "revised": "2026-09-13"
}

README badge

README badge for tristanmanchester/agent-skills/write-good-docs