posthog/ai-plugin

writing-simplified-technical-english

Write English that a reader cannot misread: one meaning per word, active voice, simple tenses, one idea per sentence, short sentences.

Voir la source

Mode d’emploi

  1. Copiez la commande et examinez le paquet avant de l’installer dans votre environnement agent.
  2. Consultez le document original pour les outils, identifiants et environnements requis.
  3. Décrivez les entrées et le livrable souhaité ; comparez la sortie aux sources.
npx skills add https://github.com/posthog/ai-plugin --skill writing-simplified-technical-english

Avant de commencer

  • L’installation n’inclut ni abonnement au modèle, ni quota API, ni accès aux fichiers.
  • Étoiles et installations reflètent l’activité, pas un test indépendant de qualité ou de sécurité.
Document Skill original

Rendu depuis le dépôt source en conservant titres, exemples, code, tableaux, liens et images.

Writing simplified technical English

ASD-STE100 is a controlled-language standard. The aerospace and defense industry wrote it so that a technician cannot misread a maintenance instruction. It removes the two biggest sources of misreading: words that carry more than one meaning, and sentences that support more than one structure.

The same discipline fixes the usual failure of agent-written prose. Agent output is often correct and unreadable: long sentences, stacked hedges, passive voice, and a synonym rotation that makes one action look like three. The reader has no author to ask, so ambiguity costs them a re-read at best and a wrong action at worst.

Apply the rules below as you write. Do not write a dense draft and clean it up afterward.

When to use this

Use it for text that a person or another agent must act on:

  • Reports, findings, and summaries.
  • PR descriptions, commit messages, and code comments.
  • Instructions passed to another agent, and prompts.
  • Tool descriptions, error messages, empty states, and log lines.

Do not use it where voice is the point: marketing copy, blog posts, or anything persuasive. STE is deliberately flat. Also leave quoted text alone. If you quote a user, a log, or a document, quote it as it is.

The rules

RuleDoDo not
One meaning per wordPick one verb per action and reuse it every timeRotate "check", "verify", and "confirm" for the same action
One part of speech per word"Apply oil to the valve""Oil the valve"
Active voice"The worker deletes the file.""The file is deleted."
Simple tenses"We received the report.""We have received the report."
One idea per sentence"Open the file. Read line 3.""Open the file and read line 3, then check it matches."
Sentence length20 words or fewer for instructions, 25 or fewer for descriptionsChains of subordinate clauses
Noun clusters3 words or fewer ("fuel pump valve")"high pressure fuel pump inlet valve assembly"
No missing wordsKeep the subject, the verb, and the article, even if it reads longer"Files not backed up will be lost", which hides which files
One hedge, at most"The client version is probably out of date.""An error may have occurred which could be caused by..."
ParagraphsOne topic, 6 sentences or fewerMulti-topic paragraphs
ListsUse a list for 3 or more steps or conditionsA sequence buried in one sentence
JargonKeep the technical term you need, and define it onceUse an internal name the reader has never seen

PostHog house style sits on top of these rules and wins where the two disagree. We use American English, sentence case, and the Oxford comma. We do not use the em-dash.

How to rewrite

  1. Read the text once for meaning. Do not start rewriting before you know what it must still say.
  2. Go sentence by sentence. Name the rule each sentence breaks.
  3. Rewrite the sentence to fix that break. Keep every fact, number, condition, and qualifier.
  4. Check the result against the rules again. A rewrite often introduces a new long sentence.

Precision beats brevity. If a shorter sentence would drop a safety condition, a scope qualifier, or a number, keep the longer sentence and say why.

If the text already follows the rules, say so. Do not change compliant text.

Self-check

Before you send the text, read it once and ask:

  • Does any sentence run past 25 words?
  • Does any sentence carry two instructions?
  • Does the same action appear under two different verbs?
  • Can a passive sentence name its actor?
  • Would a reader who joins here, with no context, know what to do next?

References

  • references/writing-rules.md: the detail behind the table, plus sources.
  • references/before-after.md: worked examples of the rewrite, including agent output.

Tâches connexes

du même dépôt

Autres Skills

Tous les Skills
posthog
Officiel

exploring-llm-costs

Investigate LLM spend in PostHog — total cost over time, cost by model, provider, user, trace, or custom dimension, token and cache-hit economics, and cost regressions. Use when the user asks "how much are we spending on LLMs?", "which model / user / feature is most expensive?", "why did cost spike?", wants to build a cost dashboard or alert, or pastes a trace URL and asks about its cost.

Installations / 1h
2
GitHub Stars
98
Mis à jour
6 nov.
posthog
Officiel

exploring-llm-traces

Debug and inspect LLM/AI agent traces using PostHog's MCP tools. Use when the user pastes a trace or session URL (e.g. /ai-observability/traces/ or /ai-observability/sessions/ ), asks to debug a trace, figure out what went wrong, check if an agent used a tool correctly, verify context/files were surfaced, inspect subagent behavior, investigate LLM decisions, or analyze token usage and costs. Also use when raw SQL/HogQL against events.properties.$aiinput / $aioutputchoices returns empty — message

Installations / 1h
2
GitHub Stars
98
Mis à jour
6 nov.
posthog
Officiel

instrument-integration

Add PostHog SDK integration to your application. Use when setting up PostHog for the first time or reviewing PRs that need PostHog initialization. Covers SDK installation, provider setup, and basic configuration for any framework.

Installations / 1h
2
GitHub Stars
98
Mis à jour
6 nov.
posthog
Officiel

investigating-error-issue

Investigates a single PostHog error tracking issue end-to-end. Use when the user provides an issue ID or pastes an issue URL (/error-tracking/ ) and wants to understand the error — who it affects, what triggers it, when it started, whether it correlates with a release, browser, OS, or feature flag, and what the next step should be. Pulls aggregated metrics, sample exception events, segment breakdowns, linked replays, and synthesizes a hypothesis-grade summary in one pass.

Installations / 1h
2
GitHub Stars
98
Mis à jour
6 nov.