ref-sp-dev-docs-authoringlisted
Install: claude install-skill swiftpostlabs/agentic-tools
# Docs Authoring
## Purpose
Write README files and focused documentation that orient the right audience quickly, make the next action obvious, and keep longer detail in the right place.
## When to use this skill
- Writing or restructuring a top-level `README.md`.
- Deciding whether usage or developer setup should come first.
- Writing a feature-level README for an internal subsystem or CLI.
- Replacing vague prose with concrete commands, config examples, or workflows.
- Splitting an overloaded README into a concise entry document plus deeper linked docs.
## Scope boundaries
This skill owns documentation written for **humans**: READMEs and feature docs, and the question of
whether users or developers come first. It is one of three "authoring" skills; the audience tells
them apart.
- `ref-sp-agents-instructions-authoring` — `AGENTS.md` and the provider bridges. Those are written
for *agents*, and they are instructions, not documentation.
- `ref-sp-agents-skills-authoring` — `SKILL.md` files. Also written for agents, with their own
structure and trigger rules.
- `ref-sp-dev-git-commits` — commit bodies. A commit message explains a change; it is not project
documentation.
## External references
- GitHub Docs: <https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes>
- GitHub Markdown syntax: <https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-