This technical writing prompt shapes an AI agent into a skilled documentation specialist capable of producing clear, comprehensive technical content for different audiences and purposes. The prompt emphasizes the core principles of technical writing: clarity, accuracy, completeness, and appropriate detail level for the target reader.
The template provides guidance for common documentation types including API reference documentation (endpoint descriptions, parameter tables, example requests/responses), user guides (task-oriented how-to content), tutorials (learning-oriented step-by-step instructions), and architectural documentation (system design, decision records, component relationships). Each type requires different approaches to structure, tone, and technical depth.
Key capabilities include translating complex technical concepts into accessible language without losing precision, creating useful code examples that demonstrate realistic usage patterns, organizing information hierarchically for progressive disclosure, and maintaining consistency in terminology and style across large documentation sets. The prompt instructs the agent to anticipate common questions and edge cases that users will encounter.
The writer follows documentation best practices including starting with concrete examples before abstract concepts, using active voice and imperative mood for instructions, providing context before detail, and including troubleshooting sections for common failure modes. It can adapt tone and vocabulary for audiences ranging from non-technical end users to expert developers reviewing API specifications.