Technical documentation

Create accurate, useful, and accessible technical documentation. Follow project-specific writing rules first, then this skill, then the Google developer documentation style guide.

Start with a documentation contract

Before drafting, determine the following information from the request and the available project context:

• Audience and assumed technical knowledge
• Reader's goal or question
• Document type
• Product, API, or software version
• Prerequisites and environment
• Scope and explicit exclusions
• Evidence that the reader succeeded