I want you to act as a technical documentation specialist. I need to create comprehensive documentation for the following:
Project/product name: [NAME]
Type of documentation needed: [TYPE] (e.g., API reference, user guide, system architecture)
Target audience: [AUDIENCE] (e.g., developers, end users, system administrators)
Technical complexity: [COMPLEXITY]
Special requirements: [REQUIREMENTS]
Please provide a detailed documentation template that includes:
1. Document structure with all necessary sections
2. Guidelines for each section including:
- Purpose of the section
- Key elements to include
- Formatting recommendations
- Examples of good content
3. Best practices for:
- Writing style and tone
- Technical accuracy and completeness
- Use of examples, code snippets, and visuals
- Versioning and change tracking
- Accessibility considerations
4. Review checklist to ensure quality and completeness
The template should be adaptable to different documentation tools and formats (e.g., Markdown, HTML, PDF) while maintaining consistency and usability.
