luthersystems/elps / .claude/skills/write-docs
write-docs
Verified| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 3.0 KB |
SKILL.md
View on GitHub# /write-docs: House Writing Style
Use this style for all text you write: docs, docstrings, code comments, PR
titles and bodies, issue text, release notes and commit messages.
## Trigger
Load this skill before you write or edit any text that a person reads.
## Rules
Write in the spirit of Simplified Technical English (ASD-STE100).
1. Put the answer or the rule first. Put the details after it.
2. Keep each sentence to about 20 words or fewer.
3. Use active voice and present tense.
4. Give each word one meaning. Use the same word for the same thing.
5. Write one instruction per sentence.
6. Do not use idioms, filler or marketing adjectives. Filler includes "note
that", "it's worth noting", "simply" and "basically".
7. No mannered prose. Avoid "not X, but Y" framing, colon-then-reveal
sentences, scare quotes around invented labels, rhetorical questions
and stock phrases such as "worth noting" or "the upshot".
8. Do not use em dashes. Use a period, comma, colon or parentheses.
9. Do not use emoji. A footer that a repo requires is the only exception.
10. Be specific. Give exact names, units, numbers and versions. Cite code
as `path:line`.
11. Write for the reader's next action. Leave out internals the reader does
not need.
12. Describe what is true now. Do not tell the history of unreleased work
(drafts, earlier designs, "this replaced X, which never shipped"). A
short "alternatives considered" note is allowed only when it explains
a current design choice.
13. Never name a customer. Never include customer code or data.
14. Link GitHub items as a full markdown link or as `owner/repo#N`. Never
write a bare `#N`.
15. Use a table for comparisons, options and status. Use a list only for
parallel items.
## Do / Don't
| Don't | Do |
|-------|----|
| Why does `set!` fail? It isn't `set`: it only mutates. | `set!` only mutates an existing binding. Use `set` to create one. |
| `set!` will basically throw an error if the symbol isn't there. | `set!` returns an error when the symbol is unbound. |
| Fix #742 | Fix luthersystems/elps#742 |
| The parser was rewritten; it used to be a PEG parser that we dropped. | `parser.NewReader` returns an `rdparser` reader. |
| This blazing-fast new builtin makes JSON a breeze! | `json:load-bytes` parses JSON bytes. JSON objects become sorted-maps. |
| Note that the step budget can be exceeded in some cases. | Exhausting the step budget raises `step-budget-exceeded`. |
| See the lexer for details. | See `parser/lexer/lexer.go:55` (`ReadToken`). |
## Self-check
Run this check on the text before you submit it:
- [ ] The first sentence gives the answer or the rule.
- [ ] No sentence is longer than about 20 words.
- [ ] No em dashes, emoji, filler or marketing adjectives.
- [ ] No mannered prose: no "not X, but Y", reveals, scare quotes or
rhetorical questions.
- [ ] Every GitHub reference is a link or `owner/repo#N`.
- [ ] Names, numbers, versions and paths are exact.
- [ ] No history of unreleased work.
- [ ] No customer names, code or data.
- [ ] A reader knows what to do next.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 198k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |