← ClaudeAtlas

docs-stylelisted

How a document is written — what it opens with, how it is structured, and which sentences do not belong. TRIGGER when: writing, revising, restructuring or reviewing any long-form prose this repo or a project keeps — a docs/ page, a README section, a learnings file, a convention version README, a memory file body, or a comment running past a few lines. Invoke BEFORE the first draft, not after. DO NOT TRIGGER when: the question is whether a document is still true or complete (that is `docs-relevance`), the text is a commit message (`shared/commit-message-rules.md`), or the subject is how Claude's chat replies are shaped (that is the output style, tuned through `tune-output`).
AnotherSava/claude-code-common · ★ 1 · AI & Automation · score 74
Install: claude install-skill AnotherSava/claude-code-common
# Writing a document Every rule here was paid for by a review round on a document that already read well to its author. That is the thing to expect: prose that feels informative while being written is exactly what a reader finds bloated, and no rule below is detectable by re-reading your own draft sympathetically. Read `~/.claude/skills/docs-style/references/style-guide.md` for the worked before/after pairs. This file is the decision procedure; that one is the depth. ## When the path already answers it Ask nothing where the file's location fixes the reader. These conventions do not move, so a question about them spends an exchange to be told what the path already said. | Path | Reader | This file | |---|---|---| | A skill's own files — `SKILL.md`, and whatever it ships under `references/` or `scripts/` | Claude, executing the procedure | Does not apply | | `learnings/<topic>.md`, `memory/*.md` | Claude, consulting it mid-task | Applies | | `README.md`, `docs/**`, a convention version README | A person | Applies — ask the questions below | **A skill's own files are out of scope, not merely a different depth.** Every rule here is about how a document reads to a person: an opening that gives the reason before the definition, a header whose content a reader can predict, a sentence that does not defend itself. A SKILL.md is a procedure Claude executes, and its constraints, commands and edge cases *are* the content — trimming them so they read better removes what a run needs.