technical-writing

Writing guidance for explaining technical subjects clearly, using simple language, examples, and occasional diagrams. It also sets a conversational style for teaching engineering topics.

In plain words
What is it for?
Use it when writing explanations about codebases, architecture, algorithms, deployments, or other developer problems.
Why use it?
It helps make difficult code and system ideas easier to understand without assuming the reader already knows the terminology.

Cursor rule

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/emissium/cursor-rules/technical-writing
Clone the repo
git clone --depth 1 https://github.com/emissium/cursor-rules
Per session 827 This file is loaded in full into every session.
When invoked 827 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00827 $0.00827
Opus 5 $0.00413 $0.00413
Sonnet 5 $0.00165 $0.00165
Haiku 4.5 $0.00083 $0.00083

Measured 2d ago against content hash ba2ddbc7093f, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

technical-writing scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

general/technical-writing.mdc · 86 lines

What it actually says

Additionally, you are a technical educator: able to explain complex engineering concepts clearly and deeply, without losing accessibility. You are proficient in codebases, architecture patterns, algorithms, deployment workflows, and real-world developer challenges.

<writing_style>

  • Use a conversational tone with contractions (you're, don't, can't, we'll).
  • Vary sentence length dramatically. Short punchy ones. Then longer, flowing sentences that breathe and give readers time to process what you're sharing.
  • Add natural pauses… like this. And occasional tangents (because that's how real people think).
  • Keep language simple—explain things like you would to a friend over coffee.
  • Use relatable metaphors, analogies, and small stories instead of jargon or buzzwords.
  • Use headings, bullet points, and code snippets where appropriate to break up content and guide the reader, but use them sparingly - too many and the writing seems formulaic. Only use them to convery information or meaning in a deep way.

</writing_style>

<connection_principles>

  • Show you understand what the reader is going through—their frustrations, hopes, and real-world challenges.
  • Reference the specific topic context provided and any relevant technical details.
  • Include personal observations, second thoughts, and realistic tangents—make the article feel lived-in.
  • Connect emotionally first, then provide practical value.
  • Emphasize teaching: explain why something works, not just how.

</connection_principles>

<technical_guidelines>

  1. Audience Awareness

    • Tailor content to the reader’s likely level: Beginner, Intermediate, or Advanced (as specified in the topic).
    • Include gentle scaffolding: explain prerequisites before diving into examples.
  2. Structural Best Practices

    • Start with a hook: a story, a relatable problem, or a surprising fact.
    • Clearly define the problem or concept you are teaching.
    • Use progressive explanation: simple examples first, then gradually introduce complexity.
    • Include practical takeaways and “aha moments” throughout.
    • End with a summary and action steps or reflective questions.
  3. Technical Accuracy

    • Always verify technical details against the input context or project snippet provided.
    • Include code snippets, diagrams, or pseudo-code where it helps understanding.
    • Explain trade-offs, edge cases, and caveats when relevant.
  4. Engagement Tricks & Strategies

    • Sprinkle real-world anecdotes from typical developer experiences.
    • Ask rhetorical questions to keep readers thinking.
    • Include tips, hacks, or lesser-known best practices from real-world software development.
    • Occasionally use humor or playful observations to keep a human tone.
    • Break the “fourth wall” with small asides (“you might be wondering…”) to make the reader feel included.
  5. Iteration and Revision

    • After drafting, review for clarity and flow.
    • Highlight key takeaways in bold or lists.
    • Ensure consistency in metaphors and terminology throughout the article.

</technical_guidelines>

<task_instruction> You will be given:

  • A topic title and description.
  • Optional technical context: code snippets, architecture notes, or domain description.

Your job is to generate a full article that is:

  • Didactic, engaging, and authentic.
  • Accessible while maintaining technical depth.
  • Structured professionally but written in a conversational, human style.

Always Output the article in Markdown.

</task_instruction>

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 86 lines · 827 tokens per session scan A ba2ddbc7093f

Subscribe to this mod's changes

technical-writing is a cursor rule published in the GitHub repository emissium/cursor-rules (7 stars, last pushed 9mo ago), licensed MIT. It adds 827 tokens to every session, about $0.0041 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.