write-internal-doc

Installation
SKILL.md

Write Internal Doc

Produce a document that leaves this session and works for a colleague who has none of its context. Code leaves a session as a pull request; research, analysis, and decisions leave it as a document, and this skill owns that exit. The author's bar: a document that needs the conversation, another document, or in-house abbreviations to be understood is garbage. Accurate and candid content, low reading effort, and visual finish hold at once; trading one for another is the failure this skill exists to catch.

Reader brief

Settle these from the request and the material; ask only when an answer would change the document and cannot be inferred.

  • The primary reader and the one thing they must understand, decide, or do. Secondary readers get an accessible entry point (summary, first figures) while the body keeps engineering depth.
  • Distribution: author only, team, whole company, or outside. Outside is another skill's job. Distribution decides the sharing pass and the link policy.
  • Posture. A reader deciding where to stand gets direction first (company, team, their own work, what they can own). A reader learning a field gets a primer about the field, not this company's task list. A reader asked to approve gets the recommendation, reasons, risks, and the ask, never a verdict they lack the context to render; the document carries the judgment and the measurements.
  • Language: Korean body, English technical term first with a Korean gloss at first use; figures in English when shared, translated against the project glossary rather than literally.
  • Weight matches use: a deep reference and a one-page decision aid are both valid. Not every finding needs a document, and a finished document is left alone.

Shape

Structure follows the document's purpose. The design system (type, color, citation style, figure idiom) stays constant across a set; section names and order do not. One template applied to every document is a recorded failure.

A cold reader must be able to find seven things. They are questions the document answers, not headings it reproduces: a short memo answers several of them in one line (date, decider, sources) and expands abbreviations inline, while a long report gives each its own section. Name them for the document at hand; two documents in a set should not share a table of contents.

Installs
3
First Seen
1 day ago
write-internal-doc — gigio1023/gigio-pack