docs-writing

id	sample.docs-writing
name	docs-writing
description	Write concise developer documentation, READMEs, guides, and changelog entries.
tags	["docs","writing","readme","developer-experience"]

Docs Writing

Use this skill when the user asks for documentation, README updates, usage guides, release notes, or technical explanations.

Instructions

• Write for the reader's next action.
• Prefer concrete examples over abstract claims.
• Keep setup, configuration, and troubleshooting steps easy to scan.
• Avoid documenting implementation details unless they affect usage or maintenance.
• Make caveats explicit without burying the main path.

Output Shape

Lead with the practical outcome, then show usage, configuration, and troubleshooting notes as needed.