cyberneticlibrary

Document technical specifications and standards

technical-communicationskillsetup L164
Tibsfox/gsd-skill-creator
What it does

Write and present engineering information for diverse technical audiences

Best for

Creating engineering procedures and design documentation for long-term reference and training

Inputs
  • · Technical content
  • · Audience expertise level
  • · Communication channel (paper/presentation/manual)
Outputs
  • · Clear technical document
  • · Effective slides or diagrams
  • · Procedures/instructions
Requires
  • · CAD for diagrams
  • · Document editor
  • · Presentation software
Preconditions
  • · Subject matter expertise
  • · Audience identified
Failure modes
  • · Jargon not explained (unclear to non-experts)
  • · Diagrams misleading or ambiguous
  • · Missing information for replication
  • · Passive voice obscures responsibility
Trust signals
  • · Active voice guidance
  • · Audience analysis framework
  • · Diagram best-practices
  • · Document structure templates