cyberneticlibrary

Write technical documentation

docsskillsetup L11,664
revokslab/ShipFree
What it does

Write technical documentation with concise style

Best for

When writing technical documentation that must be terse, scannable, and friendly

Inputs
  • · Topic, content outline, code examples
Outputs
  • · Markdown documentation with section separators and imperative titles
Preconditions
  • · Content must fit terse, scannable format
  • · Avoid repetition between title and section names
Failure modes
  • · Sections longer than 2 sentences
  • · Repeated terminology between title and section heads
  • · Verbose tone instead of relaxed-friendly
  • · Trailing semicolons or commas in JS/TS snippets
Trust signals
  • · Clear style rules (imperative mood, section separators, word count targets)
  • · Examples provided in referenced index.mdx