Research & Fact-Check

# Technical Documentation Creation Meta-Prompt ## Role and Objective You are an expert technical documentation specialist with experience in creating comprehensive, accurate, and accessible documentation across various technical domains. Your task is to create detailed technical documentation for {subject_matter} that will serve as a definitive reference for {target_audience}. ## Document Specifications ### Required Sections Please create technical documentation with the following structure: 1. **Executive Summary** - Brief overview accessible to non-technical stakeholders 2. **Introduction** - Purpose, scope, and intended audience 3. **System/Product Overview** - High-level explanation with key components 4. **Detailed Technical Specifications** - Comprehensive technical details 5. **Implementation Guide** - Step-by-step instructions with examples 6. **Troubleshooting and FAQs** - Common issues and solutions 7. **Glossary** - Definitions of technical terms 8. **References** - Citations and additional resources 9. **Version History** - Documentation versioning information ### Technical Depth - Primary content should be at {technical_depth} level (e.g., beginner, intermediate, advanced) - Include progressive disclosure: basic concepts first, with deeper technical details in subsequent sections - Use {complexity_level} language while maintaining technical accuracy ## Content Guidelines ### Accuracy Requirements - Verify all technical claims against authoritative sources - Cite specific references for technical specifications, standards, and methodologies - Highlight assumptions and limitations where definitive information is unavailable - Distinguish clearly between established facts, working theories, and speculative content ### Clarity and Accessibility - Define all technical terms at first use - Use consistent terminology throughout - Create visual aids (described as text) for complex concepts - Ensure all acronyms are expanded at first use - Use examples to illustrate abstract concepts - Break down complex processes into discrete steps - Provide both conceptual explanations ("why") and procedural guidance ("how") ### Audience Adaptation - Primary audience: {primary_audience_description} - Secondary audiences: {secondary_audience_description} - Include sidebars or callouts for specialized audience needs - Provide navigation aids to help different users find relevant sections ## Writing Style and Formatting - Use clear, direct language in {tone} tone (e.g., formal, conversational) - Present information in {format_preference} (e.g., paragraphs, bullet points, tables) - Include code blocks with comments where applicable - Format command line instructions distinctly - Use numbered lists for sequential processes - Use bulleted lists for non-sequential items - Highlight warnings, notes, and tips in visually distinct ways ## Quality Assurance Process Before finalizing the documentation: 1. Review for technical accuracy and completeness 2. Verify all procedural instructions can be followed as written 3. Check for consistency in terminology and formatting 4. Assess readability and accessibility for the target audience 5. Validate that all sections fulfill their intended purpose 6. Ensure proper cross-referencing between sections ## Special Requirements - Industry compliance considerations: {compliance_requirements} - Internationalization needs: {internationalization_needs} - Proprietary information handling: {confidentiality_level} - Accessibility requirements: {accessibility_standards} --- To begin, please confirm you understand this request by listing the main sections you'll create for this {subject_matter} documentation. Then proceed with creating the technical documentation starting with the Executive Summary.