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. Your mission is to create comprehensive Documentation Standards that establish consistent practices for creating, formatting, organizing, storing, and maintaining organizational documentation—transforming ad-hoc documentation into a strategic knowledge asset. **REQUIRED INPUTS:** [ORGANIZATION_TYPE] - Organization nature (e.g., "Technology startup", "Healthcare provider", "Manufacturing company", "Professional services firm", "Government agency") [DOCUMENTATION_SCOPE] - Types of docs covered (e.g., "Technical documentation, policies, procedures, training materials", "Product documentation, API docs, user guides", "Internal wikis, project documentation, client deliverables") [PRIMARY_USERS] - Main audiences (e.g., "Engineers, product managers, support teams", "All employees", "External clients and partners", "Compliance auditors") [CURRENT_STATE] - Existing situation (e.g., "Docs scattered across Google Drive, Notion, wikis with no consistency", "Mature system needing standardization", "Starting from scratch") [TOOLS_AND_PLATFORMS] - Documentation infrastructure (e.g., "Confluence, Google Docs, GitHub", "SharePoint, Microsoft 365", "Notion, Coda, custom wiki") [COMPLIANCE_REQUIREMENTS] - Regulatory needs (e.g., "ISO 9001 documentation control", "FDA 21 CFR Part 11", "SOC 2", "GDPR", "None") [BRAND_VOICE] - Communication style (e.g., "Professional and formal", "Casual and friendly", "Technical and precise", "Clear and accessible") [ACCESSIBILITY_REQUIREMENTS] - Inclusion needs (e.g., "WCAG 2.1 AA compliance", "Multi-language support", "Screen reader compatible", "No special requirements") [MAINTENANCE_CAPABILITY] - Update resources (e.g., "Dedicated technical writers", "Subject matter experts own docs", "Distributed contributors with light oversight") **DOCUMENTATION STANDARDS FRAMEWORK PRINCIPLES:** 1. **Consistency Across Diversity**: Unified standards that work for technical docs, policies, procedures, and training materials 2. **Discoverability by Design**: Naming, tagging, structure enabling users to find what they need quickly 3. **Maintainability Over Time**: Version control, ownership, review cycles preventing documentation decay 4. **Accessibility for All**: Inclusive design ensuring documentation serves diverse users regardless of ability 5. **Quality Through Process**: Templates, checklists, review workflows maintaining high standards 6. **Scalability Architecture**: Standards that work for 10 documents or 10,000 documents 7. **User-Centric Focus**: Documentation designed for reader needs, not writer convenience **DELIVERABLE STRUCTURE:** **Section 1: Standards Overview & Governance** ✅ Purpose and scope of documentation standards ✅ Governance model (who owns standards, how they evolve) ✅ Roles and responsibilities (authors, reviewers, approvers, owners) ✅ Compliance requirements these standards address ✅ Consequences of non-compliance ✅ Exception process for special cases **Section 2: Document Types & Classification** Define taxonomy for different document categories: **Category A: Policies & Procedures** - Corporate policies (travel, expense, code of conduct) - Standard operating procedures (SOPs) - Work instructions - Compliance documentation **Category B: Technical Documentation** - Architecture documents - API documentation - System design specs - Database schemas - Integration guides **Category C: User Documentation** - End-user guides - Training materials - Quick reference cards - Video tutorials - FAQs **Category D: Project Documentation** - Project charters - Requirements documents - Meeting notes - Decision logs - Post-mortems **Category E: Knowledge Base** - How-to articles - Troubleshooting guides - Best practices - Lessons learned For each category, specify: ✅ Required vs. optional sections ✅ Approval workflow ✅ Review frequency ✅ Retention period ✅ Access controls **Section 3: Document Structure & Formatting Standards** **Universal Document Header:** ✅ Document title (clear, descriptive, keyword-rich) ✅ Document ID or number (for tracking and referencing) ✅ Version number and date ✅ Author(s) and document owner ✅ Approval authority and date approved ✅ Review schedule (next review date) ✅ Classification (Public, Internal, Confidential, Restricted) ✅ Change history table **Content Organization:** ✅ **Executive Summary**: For documents >3 pages, 1-paragraph overview at top ✅ **Table of Contents**: For documents >5 pages, auto-generated with hyperlinks ✅ **Heading Hierarchy**: H1 (document title) → H2 (major sections) → H3 (sub-sections) → H4 (details) ✅ **Body Text**: Standard font (Arial, Calibri, or platform default), 11-12pt, 1.15-1.5 line spacing ✅ **Lists**: Bullet points for unordered items, numbers for sequential steps or prioritized items ✅ **Emphasis**: Bold for key terms (first mention), italics for emphasis sparingly, avoid underline (confused with hyperlinks) ✅ **White Space**: Adequate spacing between sections, avoid walls of text ✅ **Page Layout**: Margins (1" all sides for printed docs), headers/footers with page numbers **Visual Elements Standards:** ✅ **Images**: High resolution (minimum 150 DPI), descriptive alt text, captions explaining relevance ✅ **Screenshots**: Annotated with arrows/callouts, redact sensitive information, include UI element labels ✅ **Diagrams**: Vector format (SVG, editable) preferred over rasters, legend included, colorblind-safe palettes ✅ **Tables**: Header row formatted distinctly, alternating row colors for readability, caption above table ✅ **Code Blocks**: Monospace font, syntax highlighting, line numbers for reference, proper indentation ✅ **Videos**: Closed captions/subtitles, transcript provided, chapter markers for navigation **Section 4: Writing Style Guide** **Voice and Tone:** ✅ Use [BRAND_VOICE] throughout ✅ Active voice preferred ("Click Submit" not "The Submit button should be clicked") ✅ Second person for instructions ("You should verify..." not "Users should verify...") ✅ Present tense ("The system validates..." not "The system will validate...") ✅ Conversational but professional (avoid overly formal or overly casual extremes) **Clarity Guidelines:** ✅ Short sentences (15-20 words average) ✅ Short paragraphs (3-5 sentences) ✅ One idea per paragraph ✅ Define acronyms on first use (API (Application Programming Interface)) ✅ Avoid jargon or explain when necessary ✅ Use concrete examples to illustrate abstract concepts ✅ Include context before diving into details **Consistency Standards:** ✅ Terminology: Maintain consistent word choice (e.g., always "username" not mixing with "user name" or "user ID") ✅ Capitalization: Sentence case for headings (not Title Case or ALL CAPS) ✅ Numbers: Spell out one through nine, use numerals for 10+ (unless starting sentence) ✅ Dates: Use ISO 8601 format (YYYY-MM-DD) or spell out (January 15, 2026) consistently ✅ Time: Use 12-hour clock with AM/PM or 24-hour clock consistently ✅ Phone Numbers: Consistent format (e.g., +1-555-123-4567) **Inclusive Language:** ✅ Gender-neutral terms ("they/them" as singular, "chair" not "chairman", "salesperson" not "salesman") ✅ Ability-inclusive ("person with disability" not "disabled person", avoid "suffers from", "confined to wheelchair") ✅ Culturally sensitive (avoid idioms that don't translate globally, "think outside the box", "touch base") **Section 5: Naming Conventions** **File Naming Standards:** Format: `[Category]_[Title]_[Version]_[Date].extension` Example: `SOP_Customer_Onboarding_v3.2_2026-01-15.docx` Rules: ✅ No spaces (use underscores or hyphens) ✅ Descriptive, not generic ("Q1_Sales_Report" not "Report_Final_v2") ✅ Version number included for living documents ✅ Date in YYYY-MM-DD format for sortability ✅ Lowercase or consistent capitalization ✅ Avoid special characters (! @ # $ % & *) ✅ Limit to 50 characters if possible **URL/Link Naming:** ✅ Descriptive slugs (`/documentation/api-integration-guide` not `/docs/page123`) ✅ Hierarchical structure reflecting information architecture ✅ Permanent URLs (don't break links when reorganizing) **Section 6: Metadata & Tagging** **Required Metadata Fields:** ✅ Document Type (from taxonomy) ✅ Author(s) ✅ Owner (responsible for maintenance) ✅ Created Date ✅ Last Modified Date ✅ Next Review Date ✅ Status (Draft, In Review, Approved, Archived) ✅ Keywords/Tags (3-10 relevant terms) ✅ Related Documents (links to dependencies) ✅ Audience (who should read this: Technical, Business, All) **Tagging Strategy:** ✅ Controlled vocabulary (approved tag list, not free-form) ✅ Multi-dimensional tagging (topic, audience, document type, product/feature) ✅ Synonyms mapped (single tag for "customer" vs. "client" vs. "user") **Section 7: Version Control & Change Management** **Version Numbering:** - **Major Version (X.0)**: Significant content changes, restructuring, new sections - **Minor Version (X.Y)**: Updates, clarifications, small additions - **Patch (X.Y.Z)**: Typo fixes, formatting corrections (optional tracking level) **Change Documentation:** ✅ Change History Table in document showing version, date, author, summary of changes ✅ Track Changes feature during review process ✅ Final version shows clean copy with changes accepted **Approval Workflow:** 1. Author creates draft → Status: Draft 2. Peer review (optional but recommended for technical accuracy) 3. Submit for approval → Status: In Review 4. Approver reviews and approves or requests changes 5. Upon approval → Status: Approved, Effective Date set 6. Published to appropriate location 7. Periodic review triggers (annual, biannual) → may require re-approval **Section 8: Document Storage & Organization** **Information Architecture:** ✅ Logical folder hierarchy (not more than 4 levels deep) ✅ Consistent structure across folders ✅ README files in major folders explaining contents ✅ Index/navigation page for large document sets **Example Structure:** ``` /Documentation /Policies /HR_Policies /IT_Policies /Finance_Policies /Procedures /Customer_Service /Product_Development /Sales_Operations /Technical_Docs /Architecture /API_Documentation /Integration_Guides /Training /New_Hire_Training /Role_Specific_Training /Templates ``` **Access Controls:** ✅ Public: Accessible to anyone (external documentation) ✅ Internal: All employees ✅ Confidential: Specific departments or roles ✅ Restricted: Named individuals only, audit trail of access **Section 9: Templates & Checklists** Provide templates for each major document type: ✅ Policy Document Template ✅ SOP Template ✅ Technical Specification Template ✅ User Guide Template ✅ Meeting Notes Template ✅ Project Documentation Template Each template includes: ✅ Pre-filled sections with instructions ✅ Placeholder content showing expected format ✅ Checklist for completion (what must be included) ✅ Quality checklist (review before submission) **Section 10: Review & Maintenance Cycles** **Review Frequency by Document Type:** | Document Type | Review Frequency | Triggered By | |---------------|------------------|--------------| | Policies | Annual | Calendar + regulatory changes | | SOPs | Biannual | Calendar + process changes | | Technical Docs | Quarterly | Product releases | | Training Materials | Annual | Content accuracy checks | | Project Docs | Upon project completion | Retrospective | **Review Process:** 1. Document owner receives reminder 30 days before review due date 2. Owner reviews for accuracy, updates as needed, or confirms current 3. If changes made, follows approval workflow 4. If no changes, extends review date to next cycle 5. Archived documents (no longer active) marked clearly, retained per policy **Section 11: Accessibility Standards** Meet [ACCESSIBILITY_REQUIREMENTS]: ✅ **Headings**: Proper semantic structure (H1→H2→H3, not skipping levels) ✅ **Alt Text**: All images have descriptive alt text (not "image123.png") ✅ **Link Text**: Descriptive ("Download User Guide" not "Click here") ✅ **Color Contrast**: Minimum 4.5:1 ratio for normal text, 3:1 for large text ✅ **Tables**: Header rows properly tagged, simple structure (avoid merged cells) ✅ **Document Language**: Language attribute set for screen readers ✅ **PDFs**: Tagged PDFs with proper reading order ✅ **Videos**: Captions, transcripts, audio descriptions **Section 12: Quality Assurance** **Pre-Publication Checklist:** ☐ Document follows template structure ☐ All required metadata fields completed ☐ Heading hierarchy proper (no skipped levels) ☐ Images have alt text ☐ Links tested and working ☐ Spell check and grammar check passed ☐ Technical accuracy verified by SME ☐ Accessibility standards met ☐ Version number and date updated ☐ Change history updated ☐ Approval obtained from required authorities ☐ Saved in correct location with proper naming **Peer Review Criteria:** - Accuracy: Information is correct and current - Completeness: No critical gaps in coverage - Clarity: Understandable by target audience - Consistency: Follows standards and style guide - Usability: Information findable, organized logically **Section 13: Training & Onboarding** ✅ New hire documentation training (how to find, use, contribute to docs) ✅ Documentation champion network (power users in each team) ✅ Office hours for documentation questions ✅ Examples of excellent documentation highlighted ✅ Common mistakes and how to avoid them ✅ Tool-specific training (Confluence, SharePoint, etc.) **Section 14: Metrics & Continuous Improvement** **Documentation Health Metrics:** - % of documents reviewed on schedule - Average document age (freshness) - Number of documents past review date (stale docs) - Search success rate (users finding what they need) - Page views / usage analytics - User satisfaction scores - Time-to-find information **Feedback Mechanisms:** ✅ "Was this helpful?" rating on documentation pages ✅ Comments/suggestions submission form ✅ Quarterly documentation survey ✅ Annual standards review and update process **QUALITY STANDARDS:** ✅ Standards comprehensive enough to ensure consistency across organization ✅ Specific and prescriptive (not vague guidance) ✅ Practical and realistic for your team's capability to maintain ✅ Includes examples showing good vs. bad ✅ Addresses accessibility and inclusion ✅ Scalable as documentation volume grows ✅ Regularly reviewed and updated based on feedback Now, create comprehensive Documentation Standards for [ORGANIZATION_TYPE] covering [DOCUMENTATION_SCOPE] for [PRIMARY_USERS] using [TOOLS_AND_PLATFORMS], meeting [COMPLIANCE_REQUIREMENTS], reflecting [BRAND_VOICE], and achieving [ACCESSIBILITY_REQUIREMENTS].