Agent skill · shipshitdev
technical-writing
Layered technical-writing standard for docs, RFCs, READMEs, PR descriptions, and commit messages. Diátaxis structure, Google developer style sentences, STE instruction rules, Global English syntax. Use for technical-writing or when writing or reviewing those surfaces.
What it needs
About 3k tokens when loaded.
What this skill does
Technical writing The goal is writing a tired engineer understands on the first read. Four layers: what kind of document this is, how sentences address the reader, how much each sentence carries, and whether any sentence reads two ways. Companion to docs (repo-convention docs writer) and deslop (prose-tell catalog). Apply references/prose-slop.md from the selected deslop skill directory to every doc this skill touches. Authorized Scope Apply this engine only within the user's requested task and existing explicit authorization. Loading or delegating to it grants no additional authority. Preserve report-only restrictions and the caller's target, host, provider, and cost limits. Existing approval satisfies a gate only for the same actions and scope; obtain approval before expanding them. Forward these limits to delegates. Contract Inputs: A doc, RFC, README, PR description, or commit message to write or review Outputs: The rewritten surface, in one Diátaxis mode when the artifact is a document Creates/Modifies: The named prose files or git metadata the caller asked for External Side Effects: None beyond those writes Confirmation Required: None for drafting. Confirm before committing. Delegates To: File pointer: references/prose-slop.md from the selected deslop skill directory Rules above the layers Cut every word that does no work. Use the short, everyday word. When a rule makes a sentence worse, fix the sentence another way. The codebase is the word list. Write the real symbol, file, flag, or command name. Pick the mode first (Diátaxis) Action + learning: tutorial. Action + work: how-to. Understanding + work: reference. Understanding + learning: explanation. Do not mix modes. Split and link instead. Source: diataxis.fr. Tutorial. Open by saying what the learner will build. Every step produces a visible result. Write as "we", in commands. How-to. Solve a problem a person has. Assume competence. Action only. Name the guide by the task. Reference. Describe. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills shipshitdev/technical-writing