writing-emdash-docs

Installation
SKILL.md

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

Before drafting or editing:

  1. Read docs/src/content/docs/contributing/docs-style-guide.mdx completely for public documentation. Apply its relevant voice and readability rules to other prose in the repository.
  2. Read references/docs-practice.md completely for every writing or revision task.
  3. Read references/anti-slop.md completely for every writing or revision task.
  4. Read nearby pages of the same type to preserve established structure, terminology, frontmatter, imports, and Starlight component usage.
  5. 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.
  6. Read AGENTS.md for repository-wide rules.
  7. For changesets, read .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.

Installs
6
GitHub Stars
12.2K
First Seen
9 days ago
writing-emdash-docs — emdash-cms/emdash