Meta Documentation

Documentation about the documentation - standards, conventions, and maintenance guidelines.

Documentation Standards

Content Structure

• Use clear, concise language
• Include practical examples
• Link related documents
• Maintain consistent formatting

Technical Writing Guidelines

• Write for multiple audiences (technical, business, executive)
• Include both high-level overviews and detailed technical specifications
• Use consistent terminology
• Provide context and rationale for decisions

Version Control

• All documentation is version controlled
• Changes tracked with conventional commits
• Regular reviews and updates
• Archive old versions when necessary

Maintenance Guidelines

Regular Reviews

• Quarterly review of all documentation
• Update outdated information
• Remove deprecated content
• Archive historical versions

Contribution Process

1. Create feature branch for documentation changes
2. Update relevant documents
3. Submit pull request for review
4. Merge after approval
5. Update table of contents if needed

Available Meta Documents

• Documentation TODO - Outstanding documentation tasks
• Diagrams Guide - Diagram notation and conventions

Documentation Tools

Hugo Site Generator

• Static site generation for documentation
• Markdown-based content management
• Automated deployment
• Search functionality

Sync System

• Automated content synchronization
• Frontmatter injection
• Backup and version management
• Watch mode for development

Style Guide

Headings

• Use proper heading hierarchy (H1, H2, H3, etc.)
• Include descriptive, action-oriented titles
• Maintain consistent formatting

Code Blocks

• Use appropriate language identifiers
• Include comments for complex examples
• Provide context for code snippets
• Link to full implementations when available

Links and References

• Use relative links within the documentation
• Include external references when helpful
• Maintain link integrity during updates
• Provide context for external resources

---

Meta documentation helps maintain consistency and quality across all project documentation.