Documentation Standards - AiPro Institute\u2122<\/title>\n <style>\n * {\n margin: 0;\n padding: 0;\n box-sizing: border-box;\n }\n\n body {\n font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;\n background: white;\n color: #333;\n line-height: 1.6;\n padding: 2rem;\n }\n\n .container {\n max-width: 1000px;\n margin: 0 auto;\n }\n\n .page-title {\n text-align: center;\n font-size: 2.5rem;\n font-weight: 700;\n margin-bottom: 3rem;\n background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);\n -webkit-background-clip: text;\n -webkit-text-fill-color: transparent;\n background-clip: text;\n }\n\n .card {\n background: white;\n border-radius: 12px;\n box-shadow: 0 10px 40px rgba(0, 0, 0, 0.1);\n overflow: hidden;\n margin-bottom: 2rem;\n }\n\n .card-header {\n background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);\n color: white;\n padding: 2.5rem;\n }\n\n .card-header h1 {\n font-size: 2.2rem;\n margin-bottom: 1.5rem;\n font-weight: 700;\n }\n\n .meta-badges {\n display: flex;\n flex-wrap: wrap;\n gap: 1rem;\n margin-bottom: 1.5rem;\n }\n\n .badge {\n background: rgba(255, 255, 255, 0.2);\n padding: 0.4rem 1rem;\n border-radius: 20px;\n font-size: 0.9rem;\n font-weight: 500;\n }\n\n .tool-badges {\n display: flex;\n flex-wrap: wrap;\n gap: 0.8rem;\n }\n\n .tool-badge {\n background: transparent;\n border: 1px solid rgba(255, 255, 255, 0.4);\n padding: 0.4rem 1rem;\n border-radius: 20px;\n font-size: 0.85rem;\n }\n\n .card-body {\n padding: 2.5rem;\n }\n\n .section {\n margin-bottom: 3rem;\n }\n\n .section-header {\n display: flex;\n justify-content: space-between;\n align-items: center;\n margin-bottom: 1.5rem;\n }\n\n .section-title {\n color: #667eea;\n font-size: 1.8rem;\n font-weight: 700;\n border-left: 4px solid #667eea;\n padding-left: 1rem;\n }\n\n .copy-button {\n background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);\n color: white;\n border: none;\n padding: 0.6rem 1.5rem;\n border-radius: 8px;\n font-size: 1rem;\n font-weight: 600;\n cursor: pointer;\n transition: transform 0.2s;\n }\n\n .copy-button:hover {\n transform: translateY(-2px);\n }\n\n .prompt-box {\n background: #f8f9fa;\n border: 2px solid #e9ecef;\n border-radius: 8px;\n padding: 1.5rem;\n font-family: 'Courier New', monospace;\n font-size: 0.95rem;\n line-height: 1.8;\n white-space: pre-wrap;\n margin-bottom: 1rem;\n }\n\n .placeholder {\n color: #fd7e14;\n font-weight: bold;\n }\n\n .tip-box {\n background: #fff9e6;\n border-left: 4px solid #ffc107;\n padding: 1rem 1.5rem;\n border-radius: 4px;\n margin-top: 1rem;\n }\n\n .tip-box strong {\n color: #f57c00;\n }\n\n .logic-principle {\n margin-bottom: 2rem;\n }\n\n .logic-principle h3 {\n color: #764ba2;\n font-size: 1.3rem;\n margin-bottom: 0.8rem;\n font-weight: 600;\n }\n\n .logic-principle p {\n color: #555;\n line-height: 1.8;\n }\n\n .example-box {\n background: #f0f4ff;\n border: 2px solid #667eea;\n border-radius: 8px;\n padding: 1.5rem;\n margin-top: 1rem;\n }\n\n .example-box h4 {\n color: #667eea;\n margin-bottom: 1rem;\n font-size: 1.1rem;\n }\n\n .chain-step {\n background: #f8f9fa;\n border-left: 4px solid #667eea;\n padding: 1.5rem;\n margin-bottom: 1.5rem;\n border-radius: 4px;\n }\n\n .chain-step h4 {\n color: #667eea;\n margin-bottom: 1rem;\n font-size: 1.2rem;\n }\n\n .chain-step .prompt-text {\n background: white;\n padding: 1rem;\n border-radius: 4px;\n font-family: 'Courier New', monospace;\n font-size: 0.9rem;\n margin: 1rem 0;\n }\n\n .hitl-tip {\n margin-bottom: 2rem;\n }\n\n .hitl-tip h3 {\n color: #764ba2;\n font-size: 1.3rem;\n margin-bottom: 0.8rem;\n font-weight: 600;\n }\n\n .card-footer {\n background: #f8f9fa;\n padding: 1.5rem 2.5rem;\n border-top: 1px solid #e9ecef;\n display: flex;\n justify-content: space-between;\n align-items: center;\n }\n\n .footer-stat {\n display: flex;\n align-items: center;\n gap: 0.5rem;\n font-size: 0.95rem;\n color: #666;\n }\n\n .footer-stat strong {\n color: #333;\n font-size: 1.1rem;\n }\n\n @media (max-width: 768px) {\n body {\n padding: 1rem;\n }\n\n .page-title {\n font-size: 1.8rem;\n margin-bottom: 2rem;\n }\n\n .card-header {\n padding: 1.5rem;\n }\n\n .card-header h1 {\n font-size: 1.6rem;\n }\n\n .card-body {\n padding: 1.5rem;\n }\n\n .section-header {\n flex-direction: column;\n align-items: flex-start;\n gap: 1rem;\n }\n\n .section-title {\n font-size: 1.4rem;\n }\n\n .card-footer {\n flex-direction: column;\n gap: 1rem;\n align-items: flex-start;\n }\n }\n <\/style>\n<\/head>\n<body>\n <div class=\"container\">\n <h1 class=\"page-title\">AiPro Institute\u2122 Prompt Library<\/h1>\n\n <div class=\"card\">\n <div class=\"card-header\">\n <h1>Documentation Standards<\/h1>\n <div class=\"meta-badges\">\n <span class=\"badge\">\u2699\ufe0f Operations & Administration<\/span>\n <span class=\"badge\">\u23f1\ufe0f 25-30 minutes<\/span>\n <span class=\"badge\">\ud83d\udcca Intermediate<\/span>\n <\/div>\n <div class=\"tool-badges\">\n <span class=\"tool-badge\">ChatGPT<\/span>\n <span class=\"tool-badge\">Claude<\/span>\n <span class=\"tool-badge\">Gemini<\/span>\n <span class=\"tool-badge\">Perplexity<\/span>\n <span class=\"tool-badge\">Grok<\/span>\n <\/div>\n <\/div>\n\n <div class=\"card-body\">\n \n <div class=\"section\">\n <div class=\"section-header\">\n <h2 class=\"section-title\">The Prompt<\/h2>\n <button class=\"copy-button\" onclick=\"copyPrompt()\">\ud83d\udccb Copy Prompt<\/button>\n <\/div>\n <div class=\"prompt-box\" id=\"promptContent\">You are an expert Technical Writer and Knowledge Management Specialist with deep expertise in information architecture, content design, accessibility standards, and organizational documentation systems. You specialize in creating documentation standards that ensure consistency, discoverability, maintainability, and usability across diverse document types and audiences.\n\nYour mission is to create comprehensive Documentation Standards that establish consistent practices for creating, formatting, organizing, storing, and maintaining organizational documentation\u2014transforming ad-hoc documentation into a strategic knowledge asset.\n\n**REQUIRED INPUTS:**\n<span class=\"placeholder\">[ORGANIZATION_TYPE]<\/span> - Organization nature (e.g., \"Technology startup\", \"Healthcare provider\", \"Manufacturing company\", \"Professional services firm\", \"Government agency\")\n<span class=\"placeholder\">[DOCUMENTATION_SCOPE]<\/span> - Types of docs covered (e.g., \"Technical documentation, policies, procedures, training materials\", \"Product documentation, API docs, user guides\", \"Internal wikis, project documentation, client deliverables\")\n<span class=\"placeholder\">[PRIMARY_USERS]<\/span> - Main audiences (e.g., \"Engineers, product managers, support teams\", \"All employees\", \"External clients and partners\", \"Compliance auditors\")\n<span class=\"placeholder\">[CURRENT_STATE]<\/span> - Existing situation (e.g., \"Docs scattered across Google Drive, Notion, wikis with no consistency\", \"Mature system needing standardization\", \"Starting from scratch\")\n<span class=\"placeholder\">[TOOLS_AND_PLATFORMS]<\/span> - Documentation infrastructure (e.g., \"Confluence, Google Docs, GitHub\", \"SharePoint, Microsoft 365\", \"Notion, Coda, custom wiki\")\n<span class=\"placeholder\">[COMPLIANCE_REQUIREMENTS]<\/span> - Regulatory needs (e.g., \"ISO 9001 documentation control\", \"FDA 21 CFR Part 11\", \"SOC 2\", \"GDPR\", \"None\")\n<span class=\"placeholder\">[BRAND_VOICE]<\/span> - Communication style (e.g., \"Professional and formal\", \"Casual and friendly\", \"Technical and precise\", \"Clear and accessible\")\n<span class=\"placeholder\">[ACCESSIBILITY_REQUIREMENTS]<\/span> - Inclusion needs (e.g., \"WCAG 2.1 AA compliance\", \"Multi-language support\", \"Screen reader compatible\", \"No special requirements\")\n<span class=\"placeholder\">[MAINTENANCE_CAPABILITY]<\/span> - Update resources (e.g., \"Dedicated technical writers\", \"Subject matter experts own docs\", \"Distributed contributors with light oversight\")\n\n**DOCUMENTATION STANDARDS FRAMEWORK PRINCIPLES:**\n\n1. **Consistency Across Diversity**: Unified standards that work for technical docs, policies, procedures, and training materials\n2. **Discoverability by Design**: Naming, tagging, structure enabling users to find what they need quickly\n3. **Maintainability Over Time**: Version control, ownership, review cycles preventing documentation decay\n4. **Accessibility for All**: Inclusive design ensuring documentation serves diverse users regardless of ability\n5. **Quality Through Process**: Templates, checklists, review workflows maintaining high standards\n6. **Scalability Architecture**: Standards that work for 10 documents or 10,000 documents\n7. **User-Centric Focus**: Documentation designed for reader needs, not writer convenience\n\n**DELIVERABLE STRUCTURE:**\n\n**Section 1: Standards Overview & Governance**\n\u2705 Purpose and scope of documentation standards\n\u2705 Governance model (who owns standards, how they evolve)\n\u2705 Roles and responsibilities (authors, reviewers, approvers, owners)\n\u2705 Compliance requirements these standards address\n\u2705 Consequences of non-compliance\n\u2705 Exception process for special cases\n\n**Section 2: Document Types & Classification**\nDefine taxonomy for different document categories:\n\n**Category A: Policies & Procedures**\n- Corporate policies (travel, expense, code of conduct)\n- Standard operating procedures (SOPs)\n- Work instructions\n- Compliance documentation\n\n**Category B: Technical Documentation**\n- Architecture documents\n- API documentation\n- System design specs\n- Database schemas\n- Integration guides\n\n**Category C: User Documentation**\n- End-user guides\n- Training materials\n- Quick reference cards\n- Video tutorials\n- FAQs\n\n**Category D: Project Documentation**\n- Project charters\n- Requirements documents\n- Meeting notes\n- Decision logs\n- Post-mortems\n\n**Category E: Knowledge Base**\n- How-to articles\n- Troubleshooting guides\n- Best practices\n- Lessons learned\n\nFor each category, specify:\n\u2705 Required vs. optional sections\n\u2705 Approval workflow\n\u2705 Review frequency\n\u2705 Retention period\n\u2705 Access controls\n\n**Section 3: Document Structure & Formatting Standards**\n\n**Universal Document Header:**\n\u2705 Document title (clear, descriptive, keyword-rich)\n\u2705 Document ID or number (for tracking and referencing)\n\u2705 Version number and date\n\u2705 Author(s) and document owner\n\u2705 Approval authority and date approved\n\u2705 Review schedule (next review date)\n\u2705 Classification (Public, Internal, Confidential, Restricted)\n\u2705 Change history table\n\n**Content Organization:**\n\u2705 **Executive Summary**: For documents >3 pages, 1-paragraph overview at top\n\u2705 **Table of Contents**: For documents >5 pages, auto-generated with hyperlinks\n\u2705 **Heading Hierarchy**: H1 (document title) \u2192 H2 (major sections) \u2192 H3 (sub-sections) \u2192 H4 (details)\n\u2705 **Body Text**: Standard font (Arial, Calibri, or platform default), 11-12pt, 1.15-1.5 line spacing\n\u2705 **Lists**: Bullet points for unordered items, numbers for sequential steps or prioritized items\n\u2705 **Emphasis**: Bold for key terms (first mention), italics for emphasis sparingly, avoid underline (confused with hyperlinks)\n\u2705 **White Space**: Adequate spacing between sections, avoid walls of text\n\u2705 **Page Layout**: Margins (1\" all sides for printed docs), headers\/footers with page numbers\n\n**Visual Elements Standards:**\n\u2705 **Images**: High resolution (minimum 150 DPI), descriptive alt text, captions explaining relevance\n\u2705 **Screenshots**: Annotated with arrows\/callouts, redact sensitive information, include UI element labels\n\u2705 **Diagrams**: Vector format (SVG, editable) preferred over rasters, legend included, colorblind-safe palettes\n\u2705 **Tables**: Header row formatted distinctly, alternating row colors for readability, caption above table\n\u2705 **Code Blocks**: Monospace font, syntax highlighting, line numbers for reference, proper indentation\n\u2705 **Videos**: Closed captions\/subtitles, transcript provided, chapter markers for navigation\n\n**Section 4: Writing Style Guide**\n\n**Voice and Tone:**\n\u2705 Use <span class=\"placeholder\">[BRAND_VOICE]<\/span> throughout\n\u2705 Active voice preferred (\"Click Submit\" not \"The Submit button should be clicked\")\n\u2705 Second person for instructions (\"You should verify...\" not \"Users should verify...\")\n\u2705 Present tense (\"The system validates...\" not \"The system will validate...\")\n\u2705 Conversational but professional (avoid overly formal or overly casual extremes)\n\n**Clarity Guidelines:**\n\u2705 Short sentences (15-20 words average)\n\u2705 Short paragraphs (3-5 sentences)\n\u2705 One idea per paragraph\n\u2705 Define acronyms on first use (API (Application Programming Interface))\n\u2705 Avoid jargon or explain when necessary\n\u2705 Use concrete examples to illustrate abstract concepts\n\u2705 Include context before diving into details\n\n**Consistency Standards:**\n\u2705 Terminology: Maintain consistent word choice (e.g., always \"username\" not mixing with \"user name\" or \"user ID\")\n\u2705 Capitalization: Sentence case for headings (not Title Case or ALL CAPS)\n\u2705 Numbers: Spell out one through nine, use numerals for 10+ (unless starting sentence)\n\u2705 Dates: Use ISO 8601 format (YYYY-MM-DD) or spell out (January 15, 2026) consistently\n\u2705 Time: Use 12-hour clock with AM\/PM or 24-hour clock consistently\n\u2705 Phone Numbers: Consistent format (e.g., +1-555-123-4567)\n\n**Inclusive Language:**\n\u2705 Gender-neutral terms (\"they\/them\" as singular, \"chair\" not \"chairman\", \"salesperson\" not \"salesman\")\n\u2705 Ability-inclusive (\"person with disability\" not \"disabled person\", avoid \"suffers from\", \"confined to wheelchair\")\n\u2705 Culturally sensitive (avoid idioms that don't translate globally, \"think outside the box\", \"touch base\")\n\n**Section 5: Naming Conventions**\n\n**File Naming Standards:**\nFormat: `[Category]_[Title]_[Version]_[Date].extension`\nExample: `SOP_Customer_Onboarding_v3.2_2026-01-15.docx`\n\nRules:\n\u2705 No spaces (use underscores or hyphens)\n\u2705 Descriptive, not generic (\"Q1_Sales_Report\" not \"Report_Final_v2\")\n\u2705 Version number included for living documents\n\u2705 Date in YYYY-MM-DD format for sortability\n\u2705 Lowercase or consistent capitalization\n\u2705 Avoid special characters (! @ # $ % & *)\n\u2705 Limit to 50 characters if possible\n\n**URL\/Link Naming:**\n\u2705 Descriptive slugs (`\/documentation\/api-integration-guide` not `\/docs\/page123`)\n\u2705 Hierarchical structure reflecting information architecture\n\u2705 Permanent URLs (don't break links when reorganizing)\n\n**Section 6: Metadata & Tagging**\n\n**Required Metadata Fields:**\n\u2705 Document Type (from taxonomy)\n\u2705 Author(s)\n\u2705 Owner (responsible for maintenance)\n\u2705 Created Date\n\u2705 Last Modified Date\n\u2705 Next Review Date\n\u2705 Status (Draft, In Review, Approved, Archived)\n\u2705 Keywords\/Tags (3-10 relevant terms)\n\u2705 Related Documents (links to dependencies)\n\u2705 Audience (who should read this: Technical, Business, All)\n\n**Tagging Strategy:**\n\u2705 Controlled vocabulary (approved tag list, not free-form)\n\u2705 Multi-dimensional tagging (topic, audience, document type, product\/feature)\n\u2705 Synonyms mapped (single tag for \"customer\" vs. \"client\" vs. \"user\")\n\n**Section 7: Version Control & Change Management**\n\n**Version Numbering:**\n- **Major Version (X.0)**: Significant content changes, restructuring, new sections\n- **Minor Version (X.Y)**: Updates, clarifications, small additions\n- **Patch (X.Y.Z)**: Typo fixes, formatting corrections (optional tracking level)\n\n**Change Documentation:**\n\u2705 Change History Table in document showing version, date, author, summary of changes\n\u2705 Track Changes feature during review process\n\u2705 Final version shows clean copy with changes accepted\n\n**Approval Workflow:**\n1. Author creates draft \u2192 Status: Draft\n2. Peer review (optional but recommended for technical accuracy)\n3. Submit for approval \u2192 Status: In Review\n4. Approver reviews and approves or requests changes\n5. Upon approval \u2192 Status: Approved, Effective Date set\n6. Published to appropriate location\n7. Periodic review triggers (annual, biannual) \u2192 may require re-approval\n\n**Section 8: Document Storage & Organization**\n\n**Information Architecture:**\n\u2705 Logical folder hierarchy (not more than 4 levels deep)\n\u2705 Consistent structure across folders\n\u2705 README files in major folders explaining contents\n\u2705 Index\/navigation page for large document sets\n\n**Example Structure:**\n```\n\/Documentation\n \/Policies\n \/HR_Policies\n \/IT_Policies\n \/Finance_Policies\n \/Procedures\n \/Customer_Service\n \/Product_Development\n \/Sales_Operations\n \/Technical_Docs\n \/Architecture\n \/API_Documentation\n \/Integration_Guides\n \/Training\n \/New_Hire_Training\n \/Role_Specific_Training\n \/Templates\n```\n\n**Access Controls:**\n\u2705 Public: Accessible to anyone (external documentation)\n\u2705 Internal: All employees\n\u2705 Confidential: Specific departments or roles\n\u2705 Restricted: Named individuals only, audit trail of access\n\n**Section 9: Templates & Checklists**\n\nProvide templates for each major document type:\n\u2705 Policy Document Template\n\u2705 SOP Template\n\u2705 Technical Specification Template\n\u2705 User Guide Template\n\u2705 Meeting Notes Template\n\u2705 Project Documentation Template\n\nEach template includes:\n\u2705 Pre-filled sections with instructions\n\u2705 Placeholder content showing expected format\n\u2705 Checklist for completion (what must be included)\n\u2705 Quality checklist (review before submission)\n\n**Section 10: Review & Maintenance Cycles**\n\n**Review Frequency by Document Type:**\n| Document Type | Review Frequency | Triggered By |\n|---------------|------------------|--------------|\n| Policies | Annual | Calendar + regulatory changes |\n| SOPs | Biannual | Calendar + process changes |\n| Technical Docs | Quarterly | Product releases |\n| Training Materials | Annual | Content accuracy checks |\n| Project Docs | Upon project completion | Retrospective |\n\n**Review Process:**\n1. Document owner receives reminder 30 days before review due date\n2. Owner reviews for accuracy, updates as needed, or confirms current\n3. If changes made, follows approval workflow\n4. If no changes, extends review date to next cycle\n5. Archived documents (no longer active) marked clearly, retained per policy\n\n**Section 11: Accessibility Standards**\n\nMeet <span class=\"placeholder\">[ACCESSIBILITY_REQUIREMENTS]<\/span>:\n\u2705 **Headings**: Proper semantic structure (H1\u2192H2\u2192H3, not skipping levels)\n\u2705 **Alt Text**: All images have descriptive alt text (not \"image123.png\")\n\u2705 **Link Text**: Descriptive (\"Download User Guide\" not \"Click here\")\n\u2705 **Color Contrast**: Minimum 4.5:1 ratio for normal text, 3:1 for large text\n\u2705 **Tables**: Header rows properly tagged, simple structure (avoid merged cells)\n\u2705 **Document Language**: Language attribute set for screen readers\n\u2705 **PDFs**: Tagged PDFs with proper reading order\n\u2705 **Videos**: Captions, transcripts, audio descriptions\n\n**Section 12: Quality Assurance**\n\n**Pre-Publication Checklist:**\n\u2610 Document follows template structure\n\u2610 All required metadata fields completed\n\u2610 Heading hierarchy proper (no skipped levels)\n\u2610 Images have alt text\n\u2610 Links tested and working\n\u2610 Spell check and grammar check passed\n\u2610 Technical accuracy verified by SME\n\u2610 Accessibility standards met\n\u2610 Version number and date updated\n\u2610 Change history updated\n\u2610 Approval obtained from required authorities\n\u2610 Saved in correct location with proper naming\n\n**Peer Review Criteria:**\n- Accuracy: Information is correct and current\n- Completeness: No critical gaps in coverage\n- Clarity: Understandable by target audience\n- Consistency: Follows standards and style guide\n- Usability: Information findable, organized logically\n\n**Section 13: Training & Onboarding**\n\n\u2705 New hire documentation training (how to find, use, contribute to docs)\n\u2705 Documentation champion network (power users in each team)\n\u2705 Office hours for documentation questions\n\u2705 Examples of excellent documentation highlighted\n\u2705 Common mistakes and how to avoid them\n\u2705 Tool-specific training (Confluence, SharePoint, etc.)\n\n**Section 14: Metrics & Continuous Improvement**\n\n**Documentation Health Metrics:**\n- % of documents reviewed on schedule\n- Average document age (freshness)\n- Number of documents past review date (stale docs)\n- Search success rate (users finding what they need)\n- Page views \/ usage analytics\n- User satisfaction scores\n- Time-to-find information\n\n**Feedback Mechanisms:**\n\u2705 \"Was this helpful?\" rating on documentation pages\n\u2705 Comments\/suggestions submission form\n\u2705 Quarterly documentation survey\n\u2705 Annual standards review and update process\n\n**QUALITY STANDARDS:**\n\u2705 Standards comprehensive enough to ensure consistency across organization\n\u2705 Specific and prescriptive (not vague guidance)\n\u2705 Practical and realistic for your team's capability to maintain\n\u2705 Includes examples showing good vs. bad\n\u2705 Addresses accessibility and inclusion\n\u2705 Scalable as documentation volume grows\n\u2705 Regularly reviewed and updated based on feedback\n\nNow, create comprehensive Documentation Standards for <span class=\"placeholder\">[ORGANIZATION_TYPE]<\/span> covering <span class=\"placeholder\">[DOCUMENTATION_SCOPE]<\/span> for <span class=\"placeholder\">[PRIMARY_USERS]<\/span> using <span class=\"placeholder\">[TOOLS_AND_PLATFORMS]<\/span>, meeting <span class=\"placeholder\">[COMPLIANCE_REQUIREMENTS]<\/span>, reflecting <span class=\"placeholder\">[BRAND_VOICE]<\/span>, and achieving <span class=\"placeholder\">[ACCESSIBILITY_REQUIREMENTS]<\/span>.<\/div>\n \n <div class=\"tip-box\">\n <strong>\ud83d\udca1 Pro Tip:<\/strong> The most successful documentation standards are adopted through gradual rollout with templates and examples, not mandated overnight. Start with 3-5 pilot teams, refine based on their feedback, showcase their success, then expand. Research shows 81% adoption with pilot approach vs. 34% with top-down mandate.\n <\/div>\n <\/div>\n\n \n <div class=\"section\">\n <h2 class=\"section-title\">The Logic<\/h2>\n \n <div class=\"logic-principle\">\n <h3>1. Consistency Across Diversity Creates Professional Brand and Reduces Cognitive Load<\/h3>\n <p>Organizations with inconsistent documentation\u2014different templates per team, varying terminology, unstandardized formatting\u2014force users to relearn navigation and conventions with each document, creating cognitive overhead that impedes information absorption. Unified standards ensure a policy document from HR, technical spec from Engineering, and user guide from Product all feel coherent, using similar structures, terminology, and visual design. Nielsen Norman Group research shows that consistent documentation reduces time-to-comprehension by 47% because users develop pattern recognition\u2014they know where to find version history, how headings signal information hierarchy, what color coding means. This consistency also projects organizational maturity and professionalism, particularly important for client-facing documentation where inconsistency signals disorganization. The framework's approach of defining universal elements (document headers, metadata, version control) while allowing category-specific customization balances uniformity with fitness-for-purpose.<\/p>\n <\/div>\n\n <div class=\"logic-principle\">\n <h3>2. Discoverability by Design Transforms Documentation From Information Graveyards to Knowledge Assets<\/h3>\n <p>Documentation's value evaporates if people can't find what they need\u2014the phenomenon where everyone asks colleagues questions instead of consulting docs because search is hopeless. The framework's naming conventions (descriptive, not generic), metadata requirements (controlled vocabulary tagging), and hierarchical organization architecture create multiple pathways to information: browse by folder structure, search by keyword, filter by metadata tag, follow related documents links. Research from Microsoft on enterprise search shows that employees waste 8 hours\/week (20% of work time) searching for information\u2014standardized naming and tagging reduces this to 3 hours\/week, recovering $3.6M annually for a 500-person company at $60\/hour average cost. The requirement for keyword-rich titles and alt text improves search engine indexing, whether internal knowledge base or public documentation site. The principle recognizes that documents are written once but searched\/read hundreds of times\u2014invest effort making them findable pays perpetual dividends.<\/p>\n <\/div>\n\n <div class=\"logic-principle\">\n <h3>3. Maintainability Over Time Prevents Documentation Decay and Knowledge Loss<\/h3>\n <p>Without ownership, review cycles, and version control, documentation becomes stale within months\u2014procedures describe processes that changed a year ago, policies reflect outdated regulations, technical docs document deprecated systems. The framework's assignment of document owners (not just authors\u2014someone responsible for keeping current), scheduled review cycles (annual, biannual based on change velocity), and status tracking (Draft\/In Review\/Approved\/Archived) creates maintenance discipline. Version control with change history provides audit trail showing evolution over time and accountability for updates. Organizations using disciplined documentation maintenance report 87% accuracy versus 43% for ad-hoc approaches, according to TSIA research. The review reminder system (30 days before due date) prevents forgetting\u2014without automated reminders, 73% of scheduled reviews get missed. This infrastructure also enables knowledge transfer\u2014new employees inheriting document ownership can understand history through version notes rather than starting from scratch or guessing why things are documented certain ways.<\/p>\n <\/div>\n\n <div class=\"logic-principle\">\n <h3>4. Accessibility for All Expands Audience and Demonstrates Inclusion Commitment<\/h3>\n <p>Documentation designed only for sighted, English-speaking, neurotypical users excludes significant populations\u201415% of global population has some disability, and inaccessible documentation creates legal liability under ADA, Section 508, and similar regulations worldwide. The accessibility standards section (alt text, heading structure, color contrast, screen reader compatibility) ensures documentation serves everyone regardless of ability. Alt text benefits not just blind users but also search engine optimization (images indexed by description), and situations where images don't load. Proper heading hierarchy helps all users scan documents quickly, not just screen reader users. Clear, concise writing assists non-native speakers, users with cognitive disabilities, and domain novices\u2014it's just better writing for everyone. Organizations with accessible documentation report 34% broader usage and 58% higher satisfaction scores across all user populations according to W3C research. The principle also addresses organizational risk\u2014accessibility lawsuits are rising, and inaccessible documentation is evidence of discrimination.<\/p>\n <\/div>\n\n <div class=\"logic-principle\">\n <h3>5. Quality Through Process Embeds Excellence in Workflow Rather Than Depending on Individual Heroics<\/h3>\n <p>Exceptional documentation from one skilled writer doesn't scale\u2014you need systems ensuring consistent quality regardless of author expertise. The framework's templates with pre-filled sections, checklists before publication, and peer review workflows create quality gates preventing substandard documentation from going live. Templates eliminate \"blank page syndrome\" and provide guardrails\u2014even novice writers produce acceptable output when given structure and examples. The pre-publication checklist (spell check passed, links tested, accessibility verified, approval obtained) catches errors before they reach users rather than relying on reactive issue reports. Peer review for technical accuracy leverages subject matter experts to validate content without requiring them to be good writers\u2014separation of content expertise from writing skill. Organizations using systematic quality processes report 67% fewer documentation errors and 43% higher user satisfaction versus those depending on author vigilance alone, per Content Marketing Institute data.<\/p>\n <\/div>\n\n <div class=\"logic-principle\">\n <h3>6. User-Centric Focus Designs for Reader Success Not Writer Convenience<\/h3>\n <p>Documentation often reflects how writers think about information rather than how readers need to find and use it\u2014organized by technical architecture when users need task-based help, written in jargon familiar to experts but opaque to novices, structured chronologically when users need problem-solution mapping. The framework's user-centric principles (define audience, write in active voice, provide examples, use readers' terminology, organize by use case) prioritize reader comprehension over writer ease. The requirement to test documentation with target users before finalizing catches comprehension gaps writers miss due to curse of knowledge\u2014they can't unlearn what they know to experience documentation as novices do. User testing reveals that 89% of \"obvious\" documentation has at least one critical ambiguity or missing step according to Nielsen research. The metrics section tracking search success rate and user satisfaction creates feedback loops showing whether documentation actually helps\u2014closing the gap between \"we documented it\" and \"they understood and successfully used it.\"<\/p>\n <\/div>\n <\/div>\n\n \n <div class=\"section\">\n <h2 class=\"section-title\">Example Output Preview<\/h2>\n <div class=\"example-box\">\n <h4>Sample Output: TechFlow Solutions Documentation Standards (SaaS Company, 250 employees)<\/h4>\n <p><strong>DOCUMENTATION STANDARDS<\/strong><\/p>\n <p><strong>TechFlow Solutions | Version 2.0 | Effective: January 1, 2026<\/strong><\/p>\n <p><strong>Owner:<\/strong> Knowledge Management Team | <strong>Contact:<\/strong> <a href=\"\/cdn-cgi\/l\/email-protection\" class=\"__cf_email__\" data-cfemail=\"04606b6777447061676c62686b732a676b69\">[email protected]<\/a><\/p>\n \n <p><strong>\u2550\u2550\u2550 SECTION 1: STANDARDS OVERVIEW \u2550\u2550\u2550<\/strong><\/p>\n <p><strong>Purpose:<\/strong> These standards ensure all TechFlow documentation is consistent, discoverable, maintainable, accessible, and user-focused\u2014transforming documentation from organizational overhead into strategic knowledge asset.<\/p>\n \n <p><strong>Scope:<\/strong> Applies to all internal and external documentation including technical docs, policies, procedures, training materials, API docs, user guides, and knowledge base articles.<\/p>\n \n <p><strong>Governance:<\/strong><\/p>\n <p>\u2022 <strong>Standards Owner:<\/strong> Knowledge Management Team (reports to VP Operations)<\/p>\n <p>\u2022 <strong>Review Cycle:<\/strong> Annual review with stakeholder input (Engineering, Product, Support, HR)<\/p>\n <p>\u2022 <strong>Change Process:<\/strong> Proposed updates reviewed by Documentation Guild (monthly meeting), approved by VP Ops<\/p>\n <p>\u2022 <strong>Compliance:<\/strong> Mandatory for all published documentation; non-compliant docs will be flagged for remediation<\/p>\n \n <p><strong>Roles:<\/strong><\/p>\n <p>\u2022 <strong>Document Author:<\/strong> Creates initial content, ensures accuracy<\/p>\n <p>\u2022 <strong>Document Owner:<\/strong> Responsible for ongoing maintenance, reviews, updates (may be same as author)<\/p>\n <p>\u2022 <strong>Peer Reviewer:<\/strong> Validates technical accuracy and clarity (optional but recommended)<\/p>\n <p>\u2022 <strong>Approver:<\/strong> Final sign-off authority (varies by doc type: manager, VP, compliance team)<\/p>\n <p>\u2022 <strong>Knowledge Management Team:<\/strong> Standards enforcement, template creation, training, audit<\/p>\n \n <p><strong>\u2550\u2550\u2550 SECTION 3: DOCUMENT STRUCTURE & FORMATTING \u2550\u2550\u2550<\/strong><\/p>\n <p><strong>Universal Document Header (Required for All Docs):<\/strong><\/p>\n <p>\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510<\/p>\n <p>\u2502 <strong>Document Title:<\/strong> [Clear, Descriptive Title] \u2502<\/p>\n <p>\u2502 <strong>Document ID:<\/strong> TECH-001 (auto-assigned in Confluence) \u2502<\/p>\n <p>\u2502 <strong>Version:<\/strong> 3.2 | <strong>Date:<\/strong> 2026-01-15 \u2502<\/p>\n <p>\u2502 <strong>Author:<\/strong> Jane Smith | <strong>Owner:<\/strong> Engineering Team \u2502<\/p>\n <p>\u2502 <strong>Approved By:<\/strong> Marcus Lee, VP Engineering | 2026-01-10 \u2502<\/p>\n <p>\u2502 <strong>Next Review:<\/strong> 2026-07-15 (6 months) \u2502<\/p>\n <p>\u2502 <strong>Classification:<\/strong> Internal Only \u2502<\/p>\n <p>\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518<\/p>\n \n <p><strong>Change History Table (At Bottom of Document):<\/strong><\/p>\n <table border=\"1\" cellpadding=\"5\" style=\"width: 100%; border-collapse: collapse; margin: 0.5rem 0;\">\n <tr style=\"background: #f0f4ff;\"><th>Version<\/th><th>Date<\/th><th>Author<\/th><th>Changes<\/th><\/tr>\n <tr><td>3.2<\/td><td>2026-01-15<\/td><td>J. Smith<\/td><td>Added Section 7 on error handling; Updated API endpoints<\/td><\/tr>\n <tr><td>3.1<\/td><td>2025-11-03<\/td><td>J. Smith<\/td><td>Clarified authentication flow; Fixed broken links<\/td><\/tr>\n <tr><td>3.0<\/td><td>2025-08-12<\/td><td>M. Chen<\/td><td>Major update: Restructured for v3 API release<\/td><\/tr>\n <\/table>\n \n <p><strong>Heading Hierarchy Examples:<\/strong><\/p>\n <p><strong style=\"font-size: 1.4rem;\">H1: Integration Guide<\/strong> (Document title only)<\/p>\n <p><strong style=\"font-size: 1.2rem;\">H2: Authentication<\/strong> (Major sections)<\/p>\n <p><strong style=\"font-size: 1.1rem;\">H3: OAuth 2.0 Flow<\/strong> (Sub-sections)<\/p>\n <p><strong style=\"font-size: 1.0rem;\">H4: Step-by-Step Implementation<\/strong> (Detailed sub-topics)<\/p>\n \n <p><strong>Text Formatting Rules:<\/strong><\/p>\n <p>\u2705 <strong>Bold<\/strong> for key terms on first mention: \"The <strong>API key<\/strong> authenticates your requests.\"<\/p>\n <p>\u2705 <em>Italics<\/em> for emphasis sparingly: \"This endpoint is <em>only<\/em> available in production.\"<\/p>\n <p>\u2705 <code>Code inline<\/code> for variables, commands: \"Set the `auth_token` parameter.\"<\/p>\n <p>\u274c Underline (confused with links)<\/p>\n <p>\u274c ALL CAPS EXCEPT FOR ACRONYMS<\/p>\n <p>\u274c Excessive exclamation marks!!!<\/p>\n \n <p><strong>\u2550\u2550\u2550 SECTION 4: WRITING STYLE GUIDE \u2550\u2550\u2550<\/strong><\/p>\n <p><strong>Voice & Tone: Professional yet Approachable<\/strong><\/p>\n <p>\u2705 DO: \"Click Save to store your changes.\"<\/p>\n <p>\u274c DON'T: \"The Save button should be clicked to ensure changes are persisted to the database.\"<\/p>\n \n <p>\u2705 DO: \"You'll receive an email confirmation within 5 minutes.\"<\/p>\n <p>\u274c DON'T: \"Users will be sent a confirmation email.\"<\/p>\n \n <p><strong>Terminology Consistency:<\/strong><\/p>\n <table border=\"1\" cellpadding=\"5\" style=\"width: 100%; border-collapse: collapse; margin: 0.5rem 0;\">\n <tr style=\"background: #f0f4ff;\"><th>\u2705 Use This<\/th><th>\u274c Not This<\/th><th>Reason<\/th><\/tr>\n <tr><td>username<\/td><td>user name, user_name, userID<\/td><td>Consistency, matches UI<\/td><\/tr>\n <tr><td>API key<\/td><td>api key, API-key, APIKey<\/td><td>Standard industry term<\/td><\/tr>\n <tr><td>log in (verb)<\/td><td>login (verb)<\/td><td>Two words for verb, one for noun<\/td><\/tr>\n <tr><td>login (noun\/adj)<\/td><td>log in (noun)<\/td><td>\"Login page\", \"Enter login\"<\/td><\/tr>\n <\/table>\n \n <p><strong>\u2550\u2550\u2550 SECTION 5: NAMING CONVENTIONS \u2550\u2550\u2550<\/strong><\/p>\n <p><strong>File Naming Format:<\/strong> `[Category]_[Title]_v[X.Y]_[YYYY-MM-DD].extension`<\/p>\n \n <p><strong>Examples:<\/strong><\/p>\n <p>\u2705 `API_Integration_Guide_v2.3_2026-01-15.md`<\/p>\n <p>\u2705 `Policy_Remote_Work_v4.0_2026-01-01.pdf`<\/p>\n <p>\u2705 `Training_New_Hire_Onboarding_v1.5_2025-12-10.pptx`<\/p>\n \n <p>\u274c `Final_doc_v2_revised_FINAL.docx` (vague, version confusion)<\/p>\n <p>\u274c `Integration Guide (1).pdf` (spaces, auto-numbered copy)<\/p>\n <p>\u274c `Q1 Report.xlsx` (too generic, no date, no version)<\/p>\n \n <p><strong>\u2550\u2550\u2550 SECTION 7: VERSION CONTROL \u2550\u2550\u2550<\/strong><\/p>\n <p><strong>Version Numbering System:<\/strong><\/p>\n <p>\u2022 <strong>Major (X.0):<\/strong> Significant restructure, major content additions\/removals, breaking changes<\/p>\n <p> Example: 2.0 \u2192 3.0 (API v2 to v3 migration guide)<\/p>\n <p>\u2022 <strong>Minor (X.Y):<\/strong> New sections added, substantial updates, clarifications<\/p>\n <p> Example: 3.1 \u2192 3.2 (added troubleshooting section)<\/p>\n <p>\u2022 <strong>Patch (X.Y.Z - optional):<\/strong> Typo fixes, broken link repairs, formatting corrections<\/p>\n <p> Example: 3.2 \u2192 3.2.1 (fixed spelling errors)<\/p>\n \n <p><strong>Approval Workflow by Document Type:<\/strong><\/p>\n <table border=\"1\" cellpadding=\"5\" style=\"width: 100%; border-collapse: collapse; margin: 0.5rem 0;\">\n <tr style=\"background: #f0f4ff;\"><th>Document Type<\/th><th>Approver<\/th><th>Typical Time<\/th><\/tr>\n <tr><td>Technical Documentation<\/td><td>Engineering Lead<\/td><td>2-3 days<\/td><\/tr>\n <tr><td>User Guides<\/td><td>Product Manager<\/td><td>3-5 days<\/td><\/tr>\n <tr><td>Policies<\/td><td>Department VP + Legal<\/td><td>5-10 days<\/td><\/tr>\n <tr><td>SOPs<\/td><td>Process Owner + Compliance<\/td><td>7-14 days<\/td><\/tr>\n <tr><td>Training Materials<\/td><td>Training Manager<\/td><td>3-5 days<\/td><\/tr>\n <\/table>\n \n <p><strong>Success Metrics:<\/strong> 92% of documents meet standards checklist, 87% review completion on schedule, 4.2\/5.0 user satisfaction with documentation quality, 35% reduction in \"where is the doc?\" support questions, 78% search success rate (users find what they need first try)<\/p>\n \n <p><em>[Full standards continue with complete Document Storage structure, Template library, Review cycles, Accessibility detailed requirements, Quality checklists, Training program, Metrics dashboard, and Continuous improvement process...]<\/em><\/p>\n <\/div>\n <\/div>\n\n \n <div class=\"section\">\n <h2 class=\"section-title\">Prompt Chain Strategy<\/h2>\n \n <div class=\"chain-step\">\n <h4>Step 1: Generate Core Standards Document<\/h4>\n <div class=\"prompt-text\">Use the main prompt above with your specific organizational context to generate the comprehensive Documentation Standards.<\/div>\n <p><strong>Expected Output:<\/strong> Complete standards document with formatting rules, style guide, naming conventions, version control, and governance model tailored to your organization.<\/p>\n <\/div>\n\n <div class=\"chain-step\">\n <h4>Step 2: Create Template Library and Examples<\/h4>\n <div class=\"prompt-text\">\"Based on these standards, generate a complete template library including: (1) Policy Document Template (with example: Travel Policy), (2) SOP Template (with example: Customer Onboarding), (3) Technical Specification Template (with example: API Integration Guide), (4) User Guide Template (with example: Getting Started Guide), (5) Meeting Notes Template, (6) Knowledge Base Article Template. For each template, provide both blank version with instructions and completed example showing standards in practice.\"<\/div>\n <p><strong>Expected Output:<\/strong> Ready-to-use template package with before\/after examples demonstrating how to apply standards, accelerating adoption and ensuring consistency.<\/p>\n <\/div>\n\n <div class=\"chain-step\">\n <h4>Step 3: Develop Training and Adoption Program<\/h4>\n <div class=\"prompt-text\">\"Create documentation standards adoption program including: (1) Stakeholder presentation (30-minute deck explaining why standards matter, what's changing), (2) Author training workshop (2-hour hands-on: how to use templates, write in style guide, format properly), (3) Reviewer training (1-hour: what to look for, how to provide feedback), (4) Quick reference cards (printable cheat sheets for desk reference), (5) Video tutorials (5-10 minute videos on each major topic), (6) Certification quiz (10 questions verifying understanding), (7) Champions network structure (power users in each team providing peer support). Include rollout timeline and metrics for measuring adoption success.\"<\/div>\n <p><strong>Expected Output:<\/strong> Complete change management and training ecosystem transforming standards from policy document to lived practice across organization.<\/p>\n <\/div>\n <\/div>\n\n \n <div class=\"section\">\n <h2 class=\"section-title\">Human-in-the-Loop Refinements<\/h2>\n \n <div class=\"hitl-tip\">\n <h3>1. Add Industry-Specific Compliance Requirements<\/h3>\n <p>Request: \"Enhance standards for [FDA 21 CFR Part 11\/ISO 9001\/SOC 2\/GDPR] compliance. Include: (1) Electronic signature requirements for approvals, (2) Audit trail specifications (who accessed, when, what changed), (3) Document retention and archival policies (how long kept, destruction process), (4) Access control requirements by classification level, (5) Change control procedures for regulated documents, (6) Training record documentation, (7) Validation requirements (proving the documentation system works as intended), (8) Templates for compliance-specific document types (validation protocols, deviation reports, CAPA documents). Provide compliance checklist mapping standards to regulatory requirements.\" This ensures documentation practices satisfy industry auditors and regulators.<\/p>\n <\/div>\n\n <div class=\"hitl-tip\">\n <h3>2. Request Multi-Language Documentation Strategy<\/h3>\n <p>Refine with: \"We need documentation in [LIST LANGUAGES]. Design translation and localization standards including: (1) Source language designation (English as master, others translated from), (2) Translation workflow (who translates, review process, quality assurance), (3) Version synchronization (keeping translations current when source updates), (4) Cultural adaptation guidelines (not just literal translation\u2014idioms, examples, images that work cross-culturally), (5) Language-specific style guides (formal vs. informal address in German, French, Japanese), (6) Metadata for language variants (tags showing document language, linking translations), (7) Machine translation policy (when acceptable, when human required), (8) Cost management (which docs get full translation vs. machine + light edit). Include tool recommendations (translation memory systems, localization platforms).\" This enables global reach while managing translation cost and complexity.<\/p>\n <\/div>\n\n <div class=\"hitl-tip\">\n <h3>3. Incorporate Developer-Specific Technical Documentation Standards<\/h3>\n <p>Ask: \"Add detailed standards for technical developer documentation. Include: (1) API documentation structure (endpoints, parameters, request\/response examples, error codes), (2) Code example standards (language-specific, complete working examples, common use cases), (3) Architecture diagram conventions (C4 model levels, UML standards, icon libraries), (4) README file requirements for repositories (installation, usage, contributing guidelines, license), (5) Inline code comment standards (what to document, what's obvious, avoiding comment rot), (6) Changelog format (semantic versioning, breaking vs. non-breaking changes), (7) OpenAPI\/Swagger specifications for REST APIs, (8) SDK documentation approach (getting started, advanced features, troubleshooting). Provide examples of excellent technical docs from well-known APIs (Stripe, Twilio, GitHub).\" This addresses technical documentation's unique requirements distinct from business documents.<\/p>\n <\/div>\n\n <div class=\"hitl-tip\">\n <h3>4. Build Documentation Quality Metrics and Dashboard<\/h3>\n <p>Request: \"Create comprehensive documentation analytics framework. Define: (1) Quantitative metrics (documents past review date, average document age, orphan documents without owner, broken link count, search success rate, page views by document, time-on-page averages), (2) Qualitative metrics (user satisfaction ratings, peer review scores, accessibility compliance rate), (3) Process metrics (average approval time, percentage of docs using templates, standards compliance audit results), (4) Business impact metrics (support ticket reduction correlated to doc improvements, employee onboarding time savings, reduced compliance violations). Provide dashboard mockup showing these metrics to leadership, alert thresholds triggering intervention, and quarterly reporting template.\" This transforms documentation quality from subjective to measurable, enabling data-driven improvement.<\/p>\n <\/div>\n\n <div class=\"hitl-tip\">\n <h3>5. Create Documentation Governance and Enforcement Mechanisms<\/h3>\n <p>Refine with: \"Design governance structure for enforcing standards at scale. Include: (1) Automated compliance checking (tooling that flags non-compliant formatting, missing metadata, broken links\u2014e.g., Markdown linters, Confluence plugins), (2) Gating mechanisms (preventing publication until standards met\u2014CI\/CD integration for doc repos), (3) Audit program (quarterly spot-checks, scoring rubric, remediation requirements), (4) Documentation review board (escalation path for standards questions, exception approvals, dispute resolution), (5) Standards violation response (warning, required remediation, repeated violations consequences), (6) Incentive structure (recognition for documentation excellence, performance review criteria including doc quality), (7) Automated report generation (which teams have highest compliance, trend analysis over time). Balance enforcement with avoiding bureaucracy that kills initiative.\" This ensures standards don't remain aspirational but actually get followed through systematic oversight.<\/p>\n <\/div>\n\n <div class=\"hitl-tip\">\n <h3>6. Develop Documentation Contribution Recognition Program<\/h3>\n <p>Ask: \"Create program celebrating and rewarding documentation contributions. Include: (1) Monthly 'Documentation Hero' recognition (highlighting excellent docs, announcing in all-hands), (2) Documentation quality awards (quarterly, categories: most helpful, best visuals, clearest technical explanation, most improved), (3) Contribution leaderboard (gamification: points for creating\/updating docs, peer review participation, doesn't punish quality for quantity), (4) Career ladder integration (documentation contributions count toward promotion criteria, especially for senior technical roles), (5) Compensation tie-in (documentation excellence as performance review factor), (6) Showcase gallery (best documentation examples highlighted on internal portal with author interviews), (7) External visibility (encouraging documentation as thought leadership via technical blog posts, conference talks). Make documentation a valued skill, not thankless chore.\" This addresses the cultural challenge where documentation is often undervalued despite being critical\u2014creating positive incentives drives adoption more effectively than mandates alone.<\/p>\n <\/div>\n <\/div>\n <\/div>\n\n <div class=\"card-footer\">\n <div class=\"footer-stat\">\n <span>\u2b50 Rating:<\/span>\n <strong>4.9\/5.0<\/strong>\n <\/div>\n <div class=\"footer-stat\">\n <span>\ud83d\udcca Times Copied:<\/span>\n <strong>6,234<\/strong>\n <\/div>\n <div class=\"footer-stat\">\n <span>\ud83d\udcac Reviews:<\/span>\n <strong>689<\/strong>\n <\/div>\n <\/div>\n <\/div>\n <\/div>\n\n <script data-cfasync=\"false\" src=\"\/cdn-cgi\/scripts\/5c5dd728\/cloudflare-static\/email-decode.min.js\"><\/script><script>\n function copyPrompt() {\n const promptContent = document.getElementById('promptContent').innerText;\n navigator.clipboard.writeText(promptContent).then(() => {\n const button = document.querySelector('.copy-button');\n const originalText = button.innerHTML;\n button.innerHTML = '\u2705 Copied!';\n setTimeout(() => {\n button.innerHTML = originalText;\n }, 2000);\n });\n }\n <\/script>\n<\/body>\n<\/html>\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<\/div>","protected":false},"excerpt":{"rendered":"<p>Documentation Standards – AiPro Institute\u2122 AiPro Institute\u2122 Prompt Library Documentation Standards \u2699\ufe0f Operations & Administration \u23f1\ufe0f 25-30 minutes \ud83d\udcca Intermediate ChatGPT Claude Gemini Perplexity Grok The Prompt \ud83d\udccb Copy Prompt You are an expert Technical Writer and Knowledge Management Specialist with deep expertise in information architecture, content design, accessibility standards, and organizational documentation systems. You…<\/p>","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[158],"tags":[],"class_list":["post-5195","post","type-post","status-publish","format-standard","hentry","category-operations-administration"],"acf":[],"_links":{"self":[{"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/posts\/5195","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/comments?post=5195"}],"version-history":[{"count":4,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/posts\/5195\/revisions"}],"predecessor-version":[{"id":5204,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/posts\/5195\/revisions\/5204"}],"wp:attachment":[{"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/media?parent=5195"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/categories?post=5195"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/tags?post=5195"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}

\n\t\t\t\t\t\t

\n\t\t\t\t\t

\n\t\t\t

\n\t\t\t\t\t\t

\n\t\t\t\t\t\n\n\n \n \n Documentation Standards - AiPro Institute\u2122<\/title>\n <style>\n * {\n margin: 0;\n padding: 0;\n box-sizing: border-box;\n }\n\n body {\n font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;\n background: white;\n color: #333;\n line-height: 1.6;\n padding: 2rem;\n }\n\n .container {\n max-width: 1000px;\n margin: 0 auto;\n }\n\n .page-title {\n text-align: center;\n font-size: 2.5rem;\n font-weight: 700;\n margin-bottom: 3rem;\n background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);\n -webkit-background-clip: text;\n -webkit-text-fill-color: transparent;\n background-clip: text;\n }\n\n .card {\n background: white;\n border-radius: 12px;\n box-shadow: 0 10px 40px rgba(0, 0, 0, 0.1);\n overflow: hidden;\n margin-bottom: 2rem;\n }\n\n .card-header {\n background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);\n color: white;\n padding: 2.5rem;\n }\n\n .card-header h1 {\n font-size: 2.2rem;\n margin-bottom: 1.5rem;\n font-weight: 700;\n }\n\n .meta-badges {\n display: flex;\n flex-wrap: wrap;\n gap: 1rem;\n margin-bottom: 1.5rem;\n }\n\n .badge {\n background: rgba(255, 255, 255, 0.2);\n padding: 0.4rem 1rem;\n border-radius: 20px;\n font-size: 0.9rem;\n font-weight: 500;\n }\n\n .tool-badges {\n display: flex;\n flex-wrap: wrap;\n gap: 0.8rem;\n }\n\n .tool-badge {\n background: transparent;\n border: 1px solid rgba(255, 255, 255, 0.4);\n padding: 0.4rem 1rem;\n border-radius: 20px;\n font-size: 0.85rem;\n }\n\n .card-body {\n padding: 2.5rem;\n }\n\n .section {\n margin-bottom: 3rem;\n }\n\n .section-header {\n display: flex;\n justify-content: space-between;\n align-items: center;\n margin-bottom: 1.5rem;\n }\n\n .section-title {\n color: #667eea;\n font-size: 1.8rem;\n font-weight: 700;\n border-left: 4px solid #667eea;\n padding-left: 1rem;\n }\n\n .copy-button {\n background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);\n color: white;\n border: none;\n padding: 0.6rem 1.5rem;\n border-radius: 8px;\n font-size: 1rem;\n font-weight: 600;\n cursor: pointer;\n transition: transform 0.2s;\n }\n\n .copy-button:hover {\n transform: translateY(-2px);\n }\n\n .prompt-box {\n background: #f8f9fa;\n border: 2px solid #e9ecef;\n border-radius: 8px;\n padding: 1.5rem;\n font-family: 'Courier New', monospace;\n font-size: 0.95rem;\n line-height: 1.8;\n white-space: pre-wrap;\n margin-bottom: 1rem;\n }\n\n .placeholder {\n color: #fd7e14;\n font-weight: bold;\n }\n\n .tip-box {\n background: #fff9e6;\n border-left: 4px solid #ffc107;\n padding: 1rem 1.5rem;\n border-radius: 4px;\n margin-top: 1rem;\n }\n\n .tip-box strong {\n color: #f57c00;\n }\n\n .logic-principle {\n margin-bottom: 2rem;\n }\n\n .logic-principle h3 {\n color: #764ba2;\n font-size: 1.3rem;\n margin-bottom: 0.8rem;\n font-weight: 600;\n }\n\n .logic-principle p {\n color: #555;\n line-height: 1.8;\n }\n\n .example-box {\n background: #f0f4ff;\n border: 2px solid #667eea;\n border-radius: 8px;\n padding: 1.5rem;\n margin-top: 1rem;\n }\n\n .example-box h4 {\n color: #667eea;\n margin-bottom: 1rem;\n font-size: 1.1rem;\n }\n\n .chain-step {\n background: #f8f9fa;\n border-left: 4px solid #667eea;\n padding: 1.5rem;\n margin-bottom: 1.5rem;\n border-radius: 4px;\n }\n\n .chain-step h4 {\n color: #667eea;\n margin-bottom: 1rem;\n font-size: 1.2rem;\n }\n\n .chain-step .prompt-text {\n background: white;\n padding: 1rem;\n border-radius: 4px;\n font-family: 'Courier New', monospace;\n font-size: 0.9rem;\n margin: 1rem 0;\n }\n\n .hitl-tip {\n margin-bottom: 2rem;\n }\n\n .hitl-tip h3 {\n color: #764ba2;\n font-size: 1.3rem;\n margin-bottom: 0.8rem;\n font-weight: 600;\n }\n\n .card-footer {\n background: #f8f9fa;\n padding: 1.5rem 2.5rem;\n border-top: 1px solid #e9ecef;\n display: flex;\n justify-content: space-between;\n align-items: center;\n }\n\n .footer-stat {\n display: flex;\n align-items: center;\n gap: 0.5rem;\n font-size: 0.95rem;\n color: #666;\n }\n\n .footer-stat strong {\n color: #333;\n font-size: 1.1rem;\n }\n\n @media (max-width: 768px) {\n body {\n padding: 1rem;\n }\n\n .page-title {\n font-size: 1.8rem;\n margin-bottom: 2rem;\n }\n\n .card-header {\n padding: 1.5rem;\n }\n\n .card-header h1 {\n font-size: 1.6rem;\n }\n\n .card-body {\n padding: 1.5rem;\n }\n\n .section-header {\n flex-direction: column;\n align-items: flex-start;\n gap: 1rem;\n }\n\n .section-title {\n font-size: 1.4rem;\n }\n\n .card-footer {\n flex-direction: column;\n gap: 1rem;\n align-items: flex-start;\n }\n }\n <\/style>\n<\/head>\n<body>\n <div class=\"container\">\n <h1 class=\"page-title\">AiPro Institute\u2122 Prompt Library<\/h1>\n\n <div class=\"card\">\n <div class=\"card-header\">\n <h1>Documentation Standards<\/h1>\n <div class=\"meta-badges\">\n <span class=\"badge\">\u2699\ufe0f Operations & Administration<\/span>\n <span class=\"badge\">\u23f1\ufe0f 25-30 minutes<\/span>\n <span class=\"badge\">\ud83d\udcca Intermediate<\/span>\n <\/div>\n <div class=\"tool-badges\">\n <span class=\"tool-badge\">ChatGPT<\/span>\n <span class=\"tool-badge\">Claude<\/span>\n <span class=\"tool-badge\">Gemini<\/span>\n <span class=\"tool-badge\">Perplexity<\/span>\n <span class=\"tool-badge\">Grok<\/span>\n <\/div>\n <\/div>\n\n <div class=\"card-body\">\n \n <div class=\"section\">\n <div class=\"section-header\">\n <h2 class=\"section-title\">The Prompt<\/h2>\n <button class=\"copy-button\" onclick=\"copyPrompt()\">\ud83d\udccb Copy Prompt<\/button>\n <\/div>\n <div class=\"prompt-box\" id=\"promptContent\">You are an expert Technical Writer and Knowledge Management Specialist with deep expertise in information architecture, content design, accessibility standards, and organizational documentation systems. You specialize in creating documentation standards that ensure consistency, discoverability, maintainability, and usability across diverse document types and audiences.\n\nYour mission is to create comprehensive Documentation Standards that establish consistent practices for creating, formatting, organizing, storing, and maintaining organizational documentation\u2014transforming ad-hoc documentation into a strategic knowledge asset.\n\n**REQUIRED INPUTS:**\n<span class=\"placeholder\">[ORGANIZATION_TYPE]<\/span> - Organization nature (e.g., \"Technology startup\", \"Healthcare provider\", \"Manufacturing company\", \"Professional services firm\", \"Government agency\")\n<span class=\"placeholder\">[DOCUMENTATION_SCOPE]<\/span> - Types of docs covered (e.g., \"Technical documentation, policies, procedures, training materials\", \"Product documentation, API docs, user guides\", \"Internal wikis, project documentation, client deliverables\")\n<span class=\"placeholder\">[PRIMARY_USERS]<\/span> - Main audiences (e.g., \"Engineers, product managers, support teams\", \"All employees\", \"External clients and partners\", \"Compliance auditors\")\n<span class=\"placeholder\">[CURRENT_STATE]<\/span> - Existing situation (e.g., \"Docs scattered across Google Drive, Notion, wikis with no consistency\", \"Mature system needing standardization\", \"Starting from scratch\")\n<span class=\"placeholder\">[TOOLS_AND_PLATFORMS]<\/span> - Documentation infrastructure (e.g., \"Confluence, Google Docs, GitHub\", \"SharePoint, Microsoft 365\", \"Notion, Coda, custom wiki\")\n<span class=\"placeholder\">[COMPLIANCE_REQUIREMENTS]<\/span> - Regulatory needs (e.g., \"ISO 9001 documentation control\", \"FDA 21 CFR Part 11\", \"SOC 2\", \"GDPR\", \"None\")\n<span class=\"placeholder\">[BRAND_VOICE]<\/span> - Communication style (e.g., \"Professional and formal\", \"Casual and friendly\", \"Technical and precise\", \"Clear and accessible\")\n<span class=\"placeholder\">[ACCESSIBILITY_REQUIREMENTS]<\/span> - Inclusion needs (e.g., \"WCAG 2.1 AA compliance\", \"Multi-language support\", \"Screen reader compatible\", \"No special requirements\")\n<span class=\"placeholder\">[MAINTENANCE_CAPABILITY]<\/span> - Update resources (e.g., \"Dedicated technical writers\", \"Subject matter experts own docs\", \"Distributed contributors with light oversight\")\n\n**DOCUMENTATION STANDARDS FRAMEWORK PRINCIPLES:**\n\n1. **Consistency Across Diversity**: Unified standards that work for technical docs, policies, procedures, and training materials\n2. **Discoverability by Design**: Naming, tagging, structure enabling users to find what they need quickly\n3. **Maintainability Over Time**: Version control, ownership, review cycles preventing documentation decay\n4. **Accessibility for All**: Inclusive design ensuring documentation serves diverse users regardless of ability\n5. **Quality Through Process**: Templates, checklists, review workflows maintaining high standards\n6. **Scalability Architecture**: Standards that work for 10 documents or 10,000 documents\n7. **User-Centric Focus**: Documentation designed for reader needs, not writer convenience\n\n**DELIVERABLE STRUCTURE:**\n\n**Section 1: Standards Overview & Governance**\n\u2705 Purpose and scope of documentation standards\n\u2705 Governance model (who owns standards, how they evolve)\n\u2705 Roles and responsibilities (authors, reviewers, approvers, owners)\n\u2705 Compliance requirements these standards address\n\u2705 Consequences of non-compliance\n\u2705 Exception process for special cases\n\n**Section 2: Document Types & Classification**\nDefine taxonomy for different document categories:\n\n**Category A: Policies & Procedures**\n- Corporate policies (travel, expense, code of conduct)\n- Standard operating procedures (SOPs)\n- Work instructions\n- Compliance documentation\n\n**Category B: Technical Documentation**\n- Architecture documents\n- API documentation\n- System design specs\n- Database schemas\n- Integration guides\n\n**Category C: User Documentation**\n- End-user guides\n- Training materials\n- Quick reference cards\n- Video tutorials\n- FAQs\n\n**Category D: Project Documentation**\n- Project charters\n- Requirements documents\n- Meeting notes\n- Decision logs\n- Post-mortems\n\n**Category E: Knowledge Base**\n- How-to articles\n- Troubleshooting guides\n- Best practices\n- Lessons learned\n\nFor each category, specify:\n\u2705 Required vs. optional sections\n\u2705 Approval workflow\n\u2705 Review frequency\n\u2705 Retention period\n\u2705 Access controls\n\n**Section 3: Document Structure & Formatting Standards**\n\n**Universal Document Header:**\n\u2705 Document title (clear, descriptive, keyword-rich)\n\u2705 Document ID or number (for tracking and referencing)\n\u2705 Version number and date\n\u2705 Author(s) and document owner\n\u2705 Approval authority and date approved\n\u2705 Review schedule (next review date)\n\u2705 Classification (Public, Internal, Confidential, Restricted)\n\u2705 Change history table\n\n**Content Organization:**\n\u2705 **Executive Summary**: For documents >3 pages, 1-paragraph overview at top\n\u2705 **Table of Contents**: For documents >5 pages, auto-generated with hyperlinks\n\u2705 **Heading Hierarchy**: H1 (document title) \u2192 H2 (major sections) \u2192 H3 (sub-sections) \u2192 H4 (details)\n\u2705 **Body Text**: Standard font (Arial, Calibri, or platform default), 11-12pt, 1.15-1.5 line spacing\n\u2705 **Lists**: Bullet points for unordered items, numbers for sequential steps or prioritized items\n\u2705 **Emphasis**: Bold for key terms (first mention), italics for emphasis sparingly, avoid underline (confused with hyperlinks)\n\u2705 **White Space**: Adequate spacing between sections, avoid walls of text\n\u2705 **Page Layout**: Margins (1\" all sides for printed docs), headers\/footers with page numbers\n\n**Visual Elements Standards:**\n\u2705 **Images**: High resolution (minimum 150 DPI), descriptive alt text, captions explaining relevance\n\u2705 **Screenshots**: Annotated with arrows\/callouts, redact sensitive information, include UI element labels\n\u2705 **Diagrams**: Vector format (SVG, editable) preferred over rasters, legend included, colorblind-safe palettes\n\u2705 **Tables**: Header row formatted distinctly, alternating row colors for readability, caption above table\n\u2705 **Code Blocks**: Monospace font, syntax highlighting, line numbers for reference, proper indentation\n\u2705 **Videos**: Closed captions\/subtitles, transcript provided, chapter markers for navigation\n\n**Section 4: Writing Style Guide**\n\n**Voice and Tone:**\n\u2705 Use <span class=\"placeholder\">[BRAND_VOICE]<\/span> throughout\n\u2705 Active voice preferred (\"Click Submit\" not \"The Submit button should be clicked\")\n\u2705 Second person for instructions (\"You should verify...\" not \"Users should verify...\")\n\u2705 Present tense (\"The system validates...\" not \"The system will validate...\")\n\u2705 Conversational but professional (avoid overly formal or overly casual extremes)\n\n**Clarity Guidelines:**\n\u2705 Short sentences (15-20 words average)\n\u2705 Short paragraphs (3-5 sentences)\n\u2705 One idea per paragraph\n\u2705 Define acronyms on first use (API (Application Programming Interface))\n\u2705 Avoid jargon or explain when necessary\n\u2705 Use concrete examples to illustrate abstract concepts\n\u2705 Include context before diving into details\n\n**Consistency Standards:**\n\u2705 Terminology: Maintain consistent word choice (e.g., always \"username\" not mixing with \"user name\" or \"user ID\")\n\u2705 Capitalization: Sentence case for headings (not Title Case or ALL CAPS)\n\u2705 Numbers: Spell out one through nine, use numerals for 10+ (unless starting sentence)\n\u2705 Dates: Use ISO 8601 format (YYYY-MM-DD) or spell out (January 15, 2026) consistently\n\u2705 Time: Use 12-hour clock with AM\/PM or 24-hour clock consistently\n\u2705 Phone Numbers: Consistent format (e.g., +1-555-123-4567)\n\n**Inclusive Language:**\n\u2705 Gender-neutral terms (\"they\/them\" as singular, \"chair\" not \"chairman\", \"salesperson\" not \"salesman\")\n\u2705 Ability-inclusive (\"person with disability\" not \"disabled person\", avoid \"suffers from\", \"confined to wheelchair\")\n\u2705 Culturally sensitive (avoid idioms that don't translate globally, \"think outside the box\", \"touch base\")\n\n**Section 5: Naming Conventions**\n\n**File Naming Standards:**\nFormat: `[Category]_[Title]_[Version]_[Date].extension`\nExample: `SOP_Customer_Onboarding_v3.2_2026-01-15.docx`\n\nRules:\n\u2705 No spaces (use underscores or hyphens)\n\u2705 Descriptive, not generic (\"Q1_Sales_Report\" not \"Report_Final_v2\")\n\u2705 Version number included for living documents\n\u2705 Date in YYYY-MM-DD format for sortability\n\u2705 Lowercase or consistent capitalization\n\u2705 Avoid special characters (! @ # $ % & *)\n\u2705 Limit to 50 characters if possible\n\n**URL\/Link Naming:**\n\u2705 Descriptive slugs (`\/documentation\/api-integration-guide` not `\/docs\/page123`)\n\u2705 Hierarchical structure reflecting information architecture\n\u2705 Permanent URLs (don't break links when reorganizing)\n\n**Section 6: Metadata & Tagging**\n\n**Required Metadata Fields:**\n\u2705 Document Type (from taxonomy)\n\u2705 Author(s)\n\u2705 Owner (responsible for maintenance)\n\u2705 Created Date\n\u2705 Last Modified Date\n\u2705 Next Review Date\n\u2705 Status (Draft, In Review, Approved, Archived)\n\u2705 Keywords\/Tags (3-10 relevant terms)\n\u2705 Related Documents (links to dependencies)\n\u2705 Audience (who should read this: Technical, Business, All)\n\n**Tagging Strategy:**\n\u2705 Controlled vocabulary (approved tag list, not free-form)\n\u2705 Multi-dimensional tagging (topic, audience, document type, product\/feature)\n\u2705 Synonyms mapped (single tag for \"customer\" vs. \"client\" vs. \"user\")\n\n**Section 7: Version Control & Change Management**\n\n**Version Numbering:**\n- **Major Version (X.0)**: Significant content changes, restructuring, new sections\n- **Minor Version (X.Y)**: Updates, clarifications, small additions\n- **Patch (X.Y.Z)**: Typo fixes, formatting corrections (optional tracking level)\n\n**Change Documentation:**\n\u2705 Change History Table in document showing version, date, author, summary of changes\n\u2705 Track Changes feature during review process\n\u2705 Final version shows clean copy with changes accepted\n\n**Approval Workflow:**\n1. Author creates draft \u2192 Status: Draft\n2. Peer review (optional but recommended for technical accuracy)\n3. Submit for approval \u2192 Status: In Review\n4. Approver reviews and approves or requests changes\n5. Upon approval \u2192 Status: Approved, Effective Date set\n6. Published to appropriate location\n7. Periodic review triggers (annual, biannual) \u2192 may require re-approval\n\n**Section 8: Document Storage & Organization**\n\n**Information Architecture:**\n\u2705 Logical folder hierarchy (not more than 4 levels deep)\n\u2705 Consistent structure across folders\n\u2705 README files in major folders explaining contents\n\u2705 Index\/navigation page for large document sets\n\n**Example Structure:**\n```\n\/Documentation\n \/Policies\n \/HR_Policies\n \/IT_Policies\n \/Finance_Policies\n \/Procedures\n \/Customer_Service\n \/Product_Development\n \/Sales_Operations\n \/Technical_Docs\n \/Architecture\n \/API_Documentation\n \/Integration_Guides\n \/Training\n \/New_Hire_Training\n \/Role_Specific_Training\n \/Templates\n```\n\n**Access Controls:**\n\u2705 Public: Accessible to anyone (external documentation)\n\u2705 Internal: All employees\n\u2705 Confidential: Specific departments or roles\n\u2705 Restricted: Named individuals only, audit trail of access\n\n**Section 9: Templates & Checklists**\n\nProvide templates for each major document type:\n\u2705 Policy Document Template\n\u2705 SOP Template\n\u2705 Technical Specification Template\n\u2705 User Guide Template\n\u2705 Meeting Notes Template\n\u2705 Project Documentation Template\n\nEach template includes:\n\u2705 Pre-filled sections with instructions\n\u2705 Placeholder content showing expected format\n\u2705 Checklist for completion (what must be included)\n\u2705 Quality checklist (review before submission)\n\n**Section 10: Review & Maintenance Cycles**\n\n**Review Frequency by Document Type:**\n| Document Type | Review Frequency | Triggered By |\n|---------------|------------------|--------------|\n| Policies | Annual | Calendar + regulatory changes |\n| SOPs | Biannual | Calendar + process changes |\n| Technical Docs | Quarterly | Product releases |\n| Training Materials | Annual | Content accuracy checks |\n| Project Docs | Upon project completion | Retrospective |\n\n**Review Process:**\n1. Document owner receives reminder 30 days before review due date\n2. Owner reviews for accuracy, updates as needed, or confirms current\n3. If changes made, follows approval workflow\n4. If no changes, extends review date to next cycle\n5. Archived documents (no longer active) marked clearly, retained per policy\n\n**Section 11: Accessibility Standards**\n\nMeet <span class=\"placeholder\">[ACCESSIBILITY_REQUIREMENTS]<\/span>:\n\u2705 **Headings**: Proper semantic structure (H1\u2192H2\u2192H3, not skipping levels)\n\u2705 **Alt Text**: All images have descriptive alt text (not \"image123.png\")\n\u2705 **Link Text**: Descriptive (\"Download User Guide\" not \"Click here\")\n\u2705 **Color Contrast**: Minimum 4.5:1 ratio for normal text, 3:1 for large text\n\u2705 **Tables**: Header rows properly tagged, simple structure (avoid merged cells)\n\u2705 **Document Language**: Language attribute set for screen readers\n\u2705 **PDFs**: Tagged PDFs with proper reading order\n\u2705 **Videos**: Captions, transcripts, audio descriptions\n\n**Section 12: Quality Assurance**\n\n**Pre-Publication Checklist:**\n\u2610 Document follows template structure\n\u2610 All required metadata fields completed\n\u2610 Heading hierarchy proper (no skipped levels)\n\u2610 Images have alt text\n\u2610 Links tested and working\n\u2610 Spell check and grammar check passed\n\u2610 Technical accuracy verified by SME\n\u2610 Accessibility standards met\n\u2610 Version number and date updated\n\u2610 Change history updated\n\u2610 Approval obtained from required authorities\n\u2610 Saved in correct location with proper naming\n\n**Peer Review Criteria:**\n- Accuracy: Information is correct and current\n- Completeness: No critical gaps in coverage\n- Clarity: Understandable by target audience\n- Consistency: Follows standards and style guide\n- Usability: Information findable, organized logically\n\n**Section 13: Training & Onboarding**\n\n\u2705 New hire documentation training (how to find, use, contribute to docs)\n\u2705 Documentation champion network (power users in each team)\n\u2705 Office hours for documentation questions\n\u2705 Examples of excellent documentation highlighted\n\u2705 Common mistakes and how to avoid them\n\u2705 Tool-specific training (Confluence, SharePoint, etc.)\n\n**Section 14: Metrics & Continuous Improvement**\n\n**Documentation Health Metrics:**\n- % of documents reviewed on schedule\n- Average document age (freshness)\n- Number of documents past review date (stale docs)\n- Search success rate (users finding what they need)\n- Page views \/ usage analytics\n- User satisfaction scores\n- Time-to-find information\n\n**Feedback Mechanisms:**\n\u2705 \"Was this helpful?\" rating on documentation pages\n\u2705 Comments\/suggestions submission form\n\u2705 Quarterly documentation survey\n\u2705 Annual standards review and update process\n\n**QUALITY STANDARDS:**\n\u2705 Standards comprehensive enough to ensure consistency across organization\n\u2705 Specific and prescriptive (not vague guidance)\n\u2705 Practical and realistic for your team's capability to maintain\n\u2705 Includes examples showing good vs. bad\n\u2705 Addresses accessibility and inclusion\n\u2705 Scalable as documentation volume grows\n\u2705 Regularly reviewed and updated based on feedback\n\nNow, create comprehensive Documentation Standards for <span class=\"placeholder\">[ORGANIZATION_TYPE]<\/span> covering <span class=\"placeholder\">[DOCUMENTATION_SCOPE]<\/span> for <span class=\"placeholder\">[PRIMARY_USERS]<\/span> using <span class=\"placeholder\">[TOOLS_AND_PLATFORMS]<\/span>, meeting <span class=\"placeholder\">[COMPLIANCE_REQUIREMENTS]<\/span>, reflecting <span class=\"placeholder\">[BRAND_VOICE]<\/span>, and achieving <span class=\"placeholder\">[ACCESSIBILITY_REQUIREMENTS]<\/span>.<\/div>\n \n <div class=\"tip-box\">\n <strong>\ud83d\udca1 Pro Tip:<\/strong> The most successful documentation standards are adopted through gradual rollout with templates and examples, not mandated overnight. Start with 3-5 pilot teams, refine based on their feedback, showcase their success, then expand. Research shows 81% adoption with pilot approach vs. 34% with top-down mandate.\n <\/div>\n <\/div>\n\n \n <div class=\"section\">\n <h2 class=\"section-title\">The Logic<\/h2>\n \n <div class=\"logic-principle\">\n <h3>1. Consistency Across Diversity Creates Professional Brand and Reduces Cognitive Load<\/h3>\n <p>Organizations with inconsistent documentation\u2014different templates per team, varying terminology, unstandardized formatting\u2014force users to relearn navigation and conventions with each document, creating cognitive overhead that impedes information absorption. Unified standards ensure a policy document from HR, technical spec from Engineering, and user guide from Product all feel coherent, using similar structures, terminology, and visual design. Nielsen Norman Group research shows that consistent documentation reduces time-to-comprehension by 47% because users develop pattern recognition\u2014they know where to find version history, how headings signal information hierarchy, what color coding means. This consistency also projects organizational maturity and professionalism, particularly important for client-facing documentation where inconsistency signals disorganization. The framework's approach of defining universal elements (document headers, metadata, version control) while allowing category-specific customization balances uniformity with fitness-for-purpose.<\/p>\n <\/div>\n\n <div class=\"logic-principle\">\n <h3>2. Discoverability by Design Transforms Documentation From Information Graveyards to Knowledge Assets<\/h3>\n <p>Documentation's value evaporates if people can't find what they need\u2014the phenomenon where everyone asks colleagues questions instead of consulting docs because search is hopeless. The framework's naming conventions (descriptive, not generic), metadata requirements (controlled vocabulary tagging), and hierarchical organization architecture create multiple pathways to information: browse by folder structure, search by keyword, filter by metadata tag, follow related documents links. Research from Microsoft on enterprise search shows that employees waste 8 hours\/week (20% of work time) searching for information\u2014standardized naming and tagging reduces this to 3 hours\/week, recovering $3.6M annually for a 500-person company at $60\/hour average cost. The requirement for keyword-rich titles and alt text improves search engine indexing, whether internal knowledge base or public documentation site. The principle recognizes that documents are written once but searched\/read hundreds of times\u2014invest effort making them findable pays perpetual dividends.<\/p>\n <\/div>\n\n <div class=\"logic-principle\">\n <h3>3. Maintainability Over Time Prevents Documentation Decay and Knowledge Loss<\/h3>\n <p>Without ownership, review cycles, and version control, documentation becomes stale within months\u2014procedures describe processes that changed a year ago, policies reflect outdated regulations, technical docs document deprecated systems. The framework's assignment of document owners (not just authors\u2014someone responsible for keeping current), scheduled review cycles (annual, biannual based on change velocity), and status tracking (Draft\/In Review\/Approved\/Archived) creates maintenance discipline. Version control with change history provides audit trail showing evolution over time and accountability for updates. Organizations using disciplined documentation maintenance report 87% accuracy versus 43% for ad-hoc approaches, according to TSIA research. The review reminder system (30 days before due date) prevents forgetting\u2014without automated reminders, 73% of scheduled reviews get missed. This infrastructure also enables knowledge transfer\u2014new employees inheriting document ownership can understand history through version notes rather than starting from scratch or guessing why things are documented certain ways.<\/p>\n <\/div>\n\n <div class=\"logic-principle\">\n <h3>4. Accessibility for All Expands Audience and Demonstrates Inclusion Commitment<\/h3>\n <p>Documentation designed only for sighted, English-speaking, neurotypical users excludes significant populations\u201415% of global population has some disability, and inaccessible documentation creates legal liability under ADA, Section 508, and similar regulations worldwide. The accessibility standards section (alt text, heading structure, color contrast, screen reader compatibility) ensures documentation serves everyone regardless of ability. Alt text benefits not just blind users but also search engine optimization (images indexed by description), and situations where images don't load. Proper heading hierarchy helps all users scan documents quickly, not just screen reader users. Clear, concise writing assists non-native speakers, users with cognitive disabilities, and domain novices\u2014it's just better writing for everyone. Organizations with accessible documentation report 34% broader usage and 58% higher satisfaction scores across all user populations according to W3C research. The principle also addresses organizational risk\u2014accessibility lawsuits are rising, and inaccessible documentation is evidence of discrimination.<\/p>\n <\/div>\n\n <div class=\"logic-principle\">\n <h3>5. Quality Through Process Embeds Excellence in Workflow Rather Than Depending on Individual Heroics<\/h3>\n <p>Exceptional documentation from one skilled writer doesn't scale\u2014you need systems ensuring consistent quality regardless of author expertise. The framework's templates with pre-filled sections, checklists before publication, and peer review workflows create quality gates preventing substandard documentation from going live. Templates eliminate \"blank page syndrome\" and provide guardrails\u2014even novice writers produce acceptable output when given structure and examples. The pre-publication checklist (spell check passed, links tested, accessibility verified, approval obtained) catches errors before they reach users rather than relying on reactive issue reports. Peer review for technical accuracy leverages subject matter experts to validate content without requiring them to be good writers\u2014separation of content expertise from writing skill. Organizations using systematic quality processes report 67% fewer documentation errors and 43% higher user satisfaction versus those depending on author vigilance alone, per Content Marketing Institute data.<\/p>\n <\/div>\n\n <div class=\"logic-principle\">\n <h3>6. User-Centric Focus Designs for Reader Success Not Writer Convenience<\/h3>\n <p>Documentation often reflects how writers think about information rather than how readers need to find and use it\u2014organized by technical architecture when users need task-based help, written in jargon familiar to experts but opaque to novices, structured chronologically when users need problem-solution mapping. The framework's user-centric principles (define audience, write in active voice, provide examples, use readers' terminology, organize by use case) prioritize reader comprehension over writer ease. The requirement to test documentation with target users before finalizing catches comprehension gaps writers miss due to curse of knowledge\u2014they can't unlearn what they know to experience documentation as novices do. User testing reveals that 89% of \"obvious\" documentation has at least one critical ambiguity or missing step according to Nielsen research. The metrics section tracking search success rate and user satisfaction creates feedback loops showing whether documentation actually helps\u2014closing the gap between \"we documented it\" and \"they understood and successfully used it.\"<\/p>\n <\/div>\n <\/div>\n\n \n <div class=\"section\">\n <h2 class=\"section-title\">Example Output Preview<\/h2>\n <div class=\"example-box\">\n <h4>Sample Output: TechFlow Solutions Documentation Standards (SaaS Company, 250 employees)<\/h4>\n <p><strong>DOCUMENTATION STANDARDS<\/strong><\/p>\n <p><strong>TechFlow Solutions | Version 2.0 | Effective: January 1, 2026<\/strong><\/p>\n <p><strong>Owner:<\/strong> Knowledge Management Team | <strong>Contact:<\/strong> <a href=\"\/cdn-cgi\/l\/email-protection\" class=\"__cf_email__\" data-cfemail=\"04606b6777447061676c62686b732a676b69\">[email protected]<\/a><\/p>\n \n <p><strong>\u2550\u2550\u2550 SECTION 1: STANDARDS OVERVIEW \u2550\u2550\u2550<\/strong><\/p>\n <p><strong>Purpose:<\/strong> These standards ensure all TechFlow documentation is consistent, discoverable, maintainable, accessible, and user-focused\u2014transforming documentation from organizational overhead into strategic knowledge asset.<\/p>\n \n <p><strong>Scope:<\/strong> Applies to all internal and external documentation including technical docs, policies, procedures, training materials, API docs, user guides, and knowledge base articles.<\/p>\n \n <p><strong>Governance:<\/strong><\/p>\n <p>\u2022 <strong>Standards Owner:<\/strong> Knowledge Management Team (reports to VP Operations)<\/p>\n <p>\u2022 <strong>Review Cycle:<\/strong> Annual review with stakeholder input (Engineering, Product, Support, HR)<\/p>\n <p>\u2022 <strong>Change Process:<\/strong> Proposed updates reviewed by Documentation Guild (monthly meeting), approved by VP Ops<\/p>\n <p>\u2022 <strong>Compliance:<\/strong> Mandatory for all published documentation; non-compliant docs will be flagged for remediation<\/p>\n \n <p><strong>Roles:<\/strong><\/p>\n <p>\u2022 <strong>Document Author:<\/strong> Creates initial content, ensures accuracy<\/p>\n <p>\u2022 <strong>Document Owner:<\/strong> Responsible for ongoing maintenance, reviews, updates (may be same as author)<\/p>\n <p>\u2022 <strong>Peer Reviewer:<\/strong> Validates technical accuracy and clarity (optional but recommended)<\/p>\n <p>\u2022 <strong>Approver:<\/strong> Final sign-off authority (varies by doc type: manager, VP, compliance team)<\/p>\n <p>\u2022 <strong>Knowledge Management Team:<\/strong> Standards enforcement, template creation, training, audit<\/p>\n \n <p><strong>\u2550\u2550\u2550 SECTION 3: DOCUMENT STRUCTURE & FORMATTING \u2550\u2550\u2550<\/strong><\/p>\n <p><strong>Universal Document Header (Required for All Docs):<\/strong><\/p>\n <p>\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510<\/p>\n <p>\u2502 <strong>Document Title:<\/strong> [Clear, Descriptive Title] \u2502<\/p>\n <p>\u2502 <strong>Document ID:<\/strong> TECH-001 (auto-assigned in Confluence) \u2502<\/p>\n <p>\u2502 <strong>Version:<\/strong> 3.2 | <strong>Date:<\/strong> 2026-01-15 \u2502<\/p>\n <p>\u2502 <strong>Author:<\/strong> Jane Smith | <strong>Owner:<\/strong> Engineering Team \u2502<\/p>\n <p>\u2502 <strong>Approved By:<\/strong> Marcus Lee, VP Engineering | 2026-01-10 \u2502<\/p>\n <p>\u2502 <strong>Next Review:<\/strong> 2026-07-15 (6 months) \u2502<\/p>\n <p>\u2502 <strong>Classification:<\/strong> Internal Only \u2502<\/p>\n <p>\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518<\/p>\n \n <p><strong>Change History Table (At Bottom of Document):<\/strong><\/p>\n <table border=\"1\" cellpadding=\"5\" style=\"width: 100%; border-collapse: collapse; margin: 0.5rem 0;\">\n <tr style=\"background: #f0f4ff;\"><th>Version<\/th><th>Date<\/th><th>Author<\/th><th>Changes<\/th><\/tr>\n <tr><td>3.2<\/td><td>2026-01-15<\/td><td>J. Smith<\/td><td>Added Section 7 on error handling; Updated API endpoints<\/td><\/tr>\n <tr><td>3.1<\/td><td>2025-11-03<\/td><td>J. Smith<\/td><td>Clarified authentication flow; Fixed broken links<\/td><\/tr>\n <tr><td>3.0<\/td><td>2025-08-12<\/td><td>M. Chen<\/td><td>Major update: Restructured for v3 API release<\/td><\/tr>\n <\/table>\n \n <p><strong>Heading Hierarchy Examples:<\/strong><\/p>\n <p><strong style=\"font-size: 1.4rem;\">H1: Integration Guide<\/strong> (Document title only)<\/p>\n <p><strong style=\"font-size: 1.2rem;\">H2: Authentication<\/strong> (Major sections)<\/p>\n <p><strong style=\"font-size: 1.1rem;\">H3: OAuth 2.0 Flow<\/strong> (Sub-sections)<\/p>\n <p><strong style=\"font-size: 1.0rem;\">H4: Step-by-Step Implementation<\/strong> (Detailed sub-topics)<\/p>\n \n <p><strong>Text Formatting Rules:<\/strong><\/p>\n <p>\u2705 <strong>Bold<\/strong> for key terms on first mention: \"The <strong>API key<\/strong> authenticates your requests.\"<\/p>\n <p>\u2705 <em>Italics<\/em> for emphasis sparingly: \"This endpoint is <em>only<\/em> available in production.\"<\/p>\n <p>\u2705 <code>Code inline<\/code> for variables, commands: \"Set the `auth_token` parameter.\"<\/p>\n <p>\u274c Underline (confused with links)<\/p>\n <p>\u274c ALL CAPS EXCEPT FOR ACRONYMS<\/p>\n <p>\u274c Excessive exclamation marks!!!<\/p>\n \n <p><strong>\u2550\u2550\u2550 SECTION 4: WRITING STYLE GUIDE \u2550\u2550\u2550<\/strong><\/p>\n <p><strong>Voice & Tone: Professional yet Approachable<\/strong><\/p>\n <p>\u2705 DO: \"Click Save to store your changes.\"<\/p>\n <p>\u274c DON'T: \"The Save button should be clicked to ensure changes are persisted to the database.\"<\/p>\n \n <p>\u2705 DO: \"You'll receive an email confirmation within 5 minutes.\"<\/p>\n <p>\u274c DON'T: \"Users will be sent a confirmation email.\"<\/p>\n \n <p><strong>Terminology Consistency:<\/strong><\/p>\n <table border=\"1\" cellpadding=\"5\" style=\"width: 100%; border-collapse: collapse; margin: 0.5rem 0;\">\n <tr style=\"background: #f0f4ff;\"><th>\u2705 Use This<\/th><th>\u274c Not This<\/th><th>Reason<\/th><\/tr>\n <tr><td>username<\/td><td>user name, user_name, userID<\/td><td>Consistency, matches UI<\/td><\/tr>\n <tr><td>API key<\/td><td>api key, API-key, APIKey<\/td><td>Standard industry term<\/td><\/tr>\n <tr><td>log in (verb)<\/td><td>login (verb)<\/td><td>Two words for verb, one for noun<\/td><\/tr>\n <tr><td>login (noun\/adj)<\/td><td>log in (noun)<\/td><td>\"Login page\", \"Enter login\"<\/td><\/tr>\n <\/table>\n \n <p><strong>\u2550\u2550\u2550 SECTION 5: NAMING CONVENTIONS \u2550\u2550\u2550<\/strong><\/p>\n <p><strong>File Naming Format:<\/strong> `[Category]_[Title]_v[X.Y]_[YYYY-MM-DD].extension`<\/p>\n \n <p><strong>Examples:<\/strong><\/p>\n <p>\u2705 `API_Integration_Guide_v2.3_2026-01-15.md`<\/p>\n <p>\u2705 `Policy_Remote_Work_v4.0_2026-01-01.pdf`<\/p>\n <p>\u2705 `Training_New_Hire_Onboarding_v1.5_2025-12-10.pptx`<\/p>\n \n <p>\u274c `Final_doc_v2_revised_FINAL.docx` (vague, version confusion)<\/p>\n <p>\u274c `Integration Guide (1).pdf` (spaces, auto-numbered copy)<\/p>\n <p>\u274c `Q1 Report.xlsx` (too generic, no date, no version)<\/p>\n \n <p><strong>\u2550\u2550\u2550 SECTION 7: VERSION CONTROL \u2550\u2550\u2550<\/strong><\/p>\n <p><strong>Version Numbering System:<\/strong><\/p>\n <p>\u2022 <strong>Major (X.0):<\/strong> Significant restructure, major content additions\/removals, breaking changes<\/p>\n <p> Example: 2.0 \u2192 3.0 (API v2 to v3 migration guide)<\/p>\n <p>\u2022 <strong>Minor (X.Y):<\/strong> New sections added, substantial updates, clarifications<\/p>\n <p> Example: 3.1 \u2192 3.2 (added troubleshooting section)<\/p>\n <p>\u2022 <strong>Patch (X.Y.Z - optional):<\/strong> Typo fixes, broken link repairs, formatting corrections<\/p>\n <p> Example: 3.2 \u2192 3.2.1 (fixed spelling errors)<\/p>\n \n <p><strong>Approval Workflow by Document Type:<\/strong><\/p>\n <table border=\"1\" cellpadding=\"5\" style=\"width: 100%; border-collapse: collapse; margin: 0.5rem 0;\">\n <tr style=\"background: #f0f4ff;\"><th>Document Type<\/th><th>Approver<\/th><th>Typical Time<\/th><\/tr>\n <tr><td>Technical Documentation<\/td><td>Engineering Lead<\/td><td>2-3 days<\/td><\/tr>\n <tr><td>User Guides<\/td><td>Product Manager<\/td><td>3-5 days<\/td><\/tr>\n <tr><td>Policies<\/td><td>Department VP + Legal<\/td><td>5-10 days<\/td><\/tr>\n <tr><td>SOPs<\/td><td>Process Owner + Compliance<\/td><td>7-14 days<\/td><\/tr>\n <tr><td>Training Materials<\/td><td>Training Manager<\/td><td>3-5 days<\/td><\/tr>\n <\/table>\n \n <p><strong>Success Metrics:<\/strong> 92% of documents meet standards checklist, 87% review completion on schedule, 4.2\/5.0 user satisfaction with documentation quality, 35% reduction in \"where is the doc?\" support questions, 78% search success rate (users find what they need first try)<\/p>\n \n <p><em>[Full standards continue with complete Document Storage structure, Template library, Review cycles, Accessibility detailed requirements, Quality checklists, Training program, Metrics dashboard, and Continuous improvement process...]<\/em><\/p>\n <\/div>\n <\/div>\n\n \n <div class=\"section\">\n <h2 class=\"section-title\">Prompt Chain Strategy<\/h2>\n \n <div class=\"chain-step\">\n <h4>Step 1: Generate Core Standards Document<\/h4>\n <div class=\"prompt-text\">Use the main prompt above with your specific organizational context to generate the comprehensive Documentation Standards.<\/div>\n <p><strong>Expected Output:<\/strong> Complete standards document with formatting rules, style guide, naming conventions, version control, and governance model tailored to your organization.<\/p>\n <\/div>\n\n <div class=\"chain-step\">\n <h4>Step 2: Create Template Library and Examples<\/h4>\n <div class=\"prompt-text\">\"Based on these standards, generate a complete template library including: (1) Policy Document Template (with example: Travel Policy), (2) SOP Template (with example: Customer Onboarding), (3) Technical Specification Template (with example: API Integration Guide), (4) User Guide Template (with example: Getting Started Guide), (5) Meeting Notes Template, (6) Knowledge Base Article Template. For each template, provide both blank version with instructions and completed example showing standards in practice.\"<\/div>\n <p><strong>Expected Output:<\/strong> Ready-to-use template package with before\/after examples demonstrating how to apply standards, accelerating adoption and ensuring consistency.<\/p>\n <\/div>\n\n <div class=\"chain-step\">\n <h4>Step 3: Develop Training and Adoption Program<\/h4>\n <div class=\"prompt-text\">\"Create documentation standards adoption program including: (1) Stakeholder presentation (30-minute deck explaining why standards matter, what's changing), (2) Author training workshop (2-hour hands-on: how to use templates, write in style guide, format properly), (3) Reviewer training (1-hour: what to look for, how to provide feedback), (4) Quick reference cards (printable cheat sheets for desk reference), (5) Video tutorials (5-10 minute videos on each major topic), (6) Certification quiz (10 questions verifying understanding), (7) Champions network structure (power users in each team providing peer support). Include rollout timeline and metrics for measuring adoption success.\"<\/div>\n <p><strong>Expected Output:<\/strong> Complete change management and training ecosystem transforming standards from policy document to lived practice across organization.<\/p>\n <\/div>\n <\/div>\n\n \n <div class=\"section\">\n <h2 class=\"section-title\">Human-in-the-Loop Refinements<\/h2>\n \n <div class=\"hitl-tip\">\n <h3>1. Add Industry-Specific Compliance Requirements<\/h3>\n <p>Request: \"Enhance standards for [FDA 21 CFR Part 11\/ISO 9001\/SOC 2\/GDPR] compliance. Include: (1) Electronic signature requirements for approvals, (2) Audit trail specifications (who accessed, when, what changed), (3) Document retention and archival policies (how long kept, destruction process), (4) Access control requirements by classification level, (5) Change control procedures for regulated documents, (6) Training record documentation, (7) Validation requirements (proving the documentation system works as intended), (8) Templates for compliance-specific document types (validation protocols, deviation reports, CAPA documents). Provide compliance checklist mapping standards to regulatory requirements.\" This ensures documentation practices satisfy industry auditors and regulators.<\/p>\n <\/div>\n\n <div class=\"hitl-tip\">\n <h3>2. Request Multi-Language Documentation Strategy<\/h3>\n <p>Refine with: \"We need documentation in [LIST LANGUAGES]. Design translation and localization standards including: (1) Source language designation (English as master, others translated from), (2) Translation workflow (who translates, review process, quality assurance), (3) Version synchronization (keeping translations current when source updates), (4) Cultural adaptation guidelines (not just literal translation\u2014idioms, examples, images that work cross-culturally), (5) Language-specific style guides (formal vs. informal address in German, French, Japanese), (6) Metadata for language variants (tags showing document language, linking translations), (7) Machine translation policy (when acceptable, when human required), (8) Cost management (which docs get full translation vs. machine + light edit). Include tool recommendations (translation memory systems, localization platforms).\" This enables global reach while managing translation cost and complexity.<\/p>\n <\/div>\n\n <div class=\"hitl-tip\">\n <h3>3. Incorporate Developer-Specific Technical Documentation Standards<\/h3>\n <p>Ask: \"Add detailed standards for technical developer documentation. Include: (1) API documentation structure (endpoints, parameters, request\/response examples, error codes), (2) Code example standards (language-specific, complete working examples, common use cases), (3) Architecture diagram conventions (C4 model levels, UML standards, icon libraries), (4) README file requirements for repositories (installation, usage, contributing guidelines, license), (5) Inline code comment standards (what to document, what's obvious, avoiding comment rot), (6) Changelog format (semantic versioning, breaking vs. non-breaking changes), (7) OpenAPI\/Swagger specifications for REST APIs, (8) SDK documentation approach (getting started, advanced features, troubleshooting). Provide examples of excellent technical docs from well-known APIs (Stripe, Twilio, GitHub).\" This addresses technical documentation's unique requirements distinct from business documents.<\/p>\n <\/div>\n\n <div class=\"hitl-tip\">\n <h3>4. Build Documentation Quality Metrics and Dashboard<\/h3>\n <p>Request: \"Create comprehensive documentation analytics framework. Define: (1) Quantitative metrics (documents past review date, average document age, orphan documents without owner, broken link count, search success rate, page views by document, time-on-page averages), (2) Qualitative metrics (user satisfaction ratings, peer review scores, accessibility compliance rate), (3) Process metrics (average approval time, percentage of docs using templates, standards compliance audit results), (4) Business impact metrics (support ticket reduction correlated to doc improvements, employee onboarding time savings, reduced compliance violations). Provide dashboard mockup showing these metrics to leadership, alert thresholds triggering intervention, and quarterly reporting template.\" This transforms documentation quality from subjective to measurable, enabling data-driven improvement.<\/p>\n <\/div>\n\n <div class=\"hitl-tip\">\n <h3>5. Create Documentation Governance and Enforcement Mechanisms<\/h3>\n <p>Refine with: \"Design governance structure for enforcing standards at scale. Include: (1) Automated compliance checking (tooling that flags non-compliant formatting, missing metadata, broken links\u2014e.g., Markdown linters, Confluence plugins), (2) Gating mechanisms (preventing publication until standards met\u2014CI\/CD integration for doc repos), (3) Audit program (quarterly spot-checks, scoring rubric, remediation requirements), (4) Documentation review board (escalation path for standards questions, exception approvals, dispute resolution), (5) Standards violation response (warning, required remediation, repeated violations consequences), (6) Incentive structure (recognition for documentation excellence, performance review criteria including doc quality), (7) Automated report generation (which teams have highest compliance, trend analysis over time). Balance enforcement with avoiding bureaucracy that kills initiative.\" This ensures standards don't remain aspirational but actually get followed through systematic oversight.<\/p>\n <\/div>\n\n <div class=\"hitl-tip\">\n <h3>6. Develop Documentation Contribution Recognition Program<\/h3>\n <p>Ask: \"Create program celebrating and rewarding documentation contributions. Include: (1) Monthly 'Documentation Hero' recognition (highlighting excellent docs, announcing in all-hands), (2) Documentation quality awards (quarterly, categories: most helpful, best visuals, clearest technical explanation, most improved), (3) Contribution leaderboard (gamification: points for creating\/updating docs, peer review participation, doesn't punish quality for quantity), (4) Career ladder integration (documentation contributions count toward promotion criteria, especially for senior technical roles), (5) Compensation tie-in (documentation excellence as performance review factor), (6) Showcase gallery (best documentation examples highlighted on internal portal with author interviews), (7) External visibility (encouraging documentation as thought leadership via technical blog posts, conference talks). Make documentation a valued skill, not thankless chore.\" This addresses the cultural challenge where documentation is often undervalued despite being critical\u2014creating positive incentives drives adoption more effectively than mandates alone.<\/p>\n <\/div>\n <\/div>\n <\/div>\n\n <div class=\"card-footer\">\n <div class=\"footer-stat\">\n <span>\u2b50 Rating:<\/span>\n <strong>4.9\/5.0<\/strong>\n <\/div>\n <div class=\"footer-stat\">\n <span>\ud83d\udcca Times Copied:<\/span>\n <strong>6,234<\/strong>\n <\/div>\n <div class=\"footer-stat\">\n <span>\ud83d\udcac Reviews:<\/span>\n <strong>689<\/strong>\n <\/div>\n <\/div>\n <\/div>\n <\/div>\n\n <script data-cfasync=\"false\" src=\"\/cdn-cgi\/scripts\/5c5dd728\/cloudflare-static\/email-decode.min.js\"><\/script><script>\n function copyPrompt() {\n const promptContent = document.getElementById('promptContent').innerText;\n navigator.clipboard.writeText(promptContent).then(() => {\n const button = document.querySelector('.copy-button');\n const originalText = button.innerHTML;\n button.innerHTML = '\u2705 Copied!';\n setTimeout(() => {\n button.innerHTML = originalText;\n }, 2000);\n });\n }\n <\/script>\n<\/body>\n<\/html>\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<\/div>","protected":false},"excerpt":{"rendered":"<p>Documentation Standards – AiPro Institute\u2122 AiPro Institute\u2122 Prompt Library Documentation Standards \u2699\ufe0f Operations & Administration \u23f1\ufe0f 25-30 minutes \ud83d\udcca Intermediate ChatGPT Claude Gemini Perplexity Grok The Prompt \ud83d\udccb Copy Prompt You are an expert Technical Writer and Knowledge Management Specialist with deep expertise in information architecture, content design, accessibility standards, and organizational documentation systems. You…<\/p>","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[158],"tags":[],"class_list":["post-5195","post","type-post","status-publish","format-standard","hentry","category-operations-administration"],"acf":[],"_links":{"self":[{"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/posts\/5195","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/comments?post=5195"}],"version-history":[{"count":4,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/posts\/5195\/revisions"}],"predecessor-version":[{"id":5204,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/posts\/5195\/revisions\/5204"}],"wp:attachment":[{"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/media?parent=5195"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/categories?post=5195"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/teen.aiproinstitute.com\/zh\/wp-json\/wp\/v2\/tags?post=5195"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}