# Writing Emdash Docs

Write, revise, and review EmDash documentation for technical accuracy, useful...

- Repository: https://github.com/emdash-cms/emdash (14094 stars)
- Category: Writing
- License: MIT
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add emdash-cms/emdash --skill writing-emdash-docs -g -a claude-code -y`
Codex: `npx skills add emdash-cms/emdash --skill writing-emdash-docs -g -a codex -y`
Cursor: `npx skills add emdash-cms/emdash --skill writing-emdash-docs -g -a cursor -y`
Gemini CLI: `npx skills add emdash-cms/emdash --skill writing-emdash-docs -g -a gemini-cli -y`

## Description

Write, revise, and review EmDash documentation for technical accuracy, useful structure, house style, and natural prose. Use when working on user documentation, guides, API reference pages, migration or upgrade guides, READMEs, contributor documentation, technical specifications, or release notes in the EmDash repository, and when asked to improve, audit, de-slop, or humanize existing documentation.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Writing EmDash docs

Produce documentation that helps a specific reader complete a task or understand a concrete part of EmDash. Treat factual accuracy, information design, and sentence-level style as separate checks.

## Load the right context

Load only the context needed for the artifact:

1. Read `AGENTS.md` for repository-wide rules.
2. For public documentation, read `docs/src/content/docs/contributing/docs-style-guide.mdx` completely.
3. Read [references/docs-practice.md](references/docs-practice.md) when creating or restructuring a page, changing a task path, reviewing accessibility or information architecture, or writing substantial examples.
4. Read [references/anti-slop.md](references/anti-slop.md) for prose-heavy revisions, de-slopping, or humanization. A small factual correction does not require loading it.
5. Read nearby pages of the same type to preserve established structure, terminology, frontmatter, imports, and Starlight component usage.
6. Inspect the implementation, types, tests, command help, or configuration that establishes every technical claim. Do not rely on memory when the repository can answer the question.
7. For changesets, read [.changeset/README.md](../../.changeset/README.md) completely. Treat the entry as public CHANGELOG documentation and review whether affected readers can recognize the surface, understand the observable effect, and act on any migration guidance. Frontmatter validity and technical accuracy do not make an unhelpful entry acceptable.

## Define the reader and outcome

State the intended outcome privately in one sentence: "After reading this, the reader can ..." Use it to decide what belongs on the page.

Classify the document before choosing its structure:

The rest: https://github.com/emdash-cms/emdash/blob/HEAD/skills/writing-emdash-docs/SKILL.md