Skip to content

Wiki Structure

Goal: Organized, discoverable, up-to-date knowledge base

Wiki Organization

Wiki Home
├── Getting Started/
│   ├── Quick Start Guide
│   ├── Development Setup
│   ├── First Contribution
│   └── FAQ
│
├── Architecture/
│   ├── System Overview
│   ├── Audio Processing Pipeline
│   ├── Plugin Architecture
│   ├── State Management
│   ├── Threading Model
│   └── Platform Abstraction
│
├── Development/
│   ├── Coding Standards
│   ├── Build System
│   ├── Testing Guide
│   ├── Debugging Tips
│   ├── Performance Profiling
│   └── Platform-Specific Notes
│
├── Processes/
│   ├── Git Workflow
│   ├── Code Review Process
│   ├── Release Process
│   ├── Sprint Planning
│   └── On-Call Rotation
│
├── Troubleshooting/
│   ├── Common Build Issues
│   ├── Audio Glitches Debugging
│   ├── Platform-Specific Issues
│   ├── Performance Problems
│   └── DAW Compatibility
│
├── Learning Resources/
│   ├── Audio DSP Fundamentals
│   ├── Recommended Reading
│   ├── Talks & Presentations
│   ├── External Resources
│   └── Team Knowledge Shares
│
├── Decisions/ (ADRs)
│   ├── ADR Index
│   ├── ADR-001: Use C++17
│   ├── ADR-002: Lock-free Audio Thread
│   └── ...
│
└── Runbooks/
    ├── Deployment
    ├── Incident Response
    ├── Database Migration
    └── Performance Investigation

Content Guidelines

Page Structure

# Page Title

**Last updated**: 2024-04-01
**Owner**: @username
**Status**: Current | Outdated | Deprecated

## Overview
<!-- Brief summary -->

## Details
<!-- Main content -->

## Related
- [Related Page 1](link)
- [Related Page 2](link)

## See Also
- External resource 1
- External resource 2

Keep Pages

  • Focused: One topic per page
  • Current: Review quarterly, mark outdated
  • Linked: Connect related pages
  • Searchable: Use clear titles and keywords
  • Actionable: Include examples, not just theory

Maintenance

Quarterly Review

  • Check all pages for accuracy
  • Update outdated information
  • Remove obsolete pages
  • Add missing documentation

Page Owners

  • Each critical page has owner
  • Owner reviews and updates
  • Owner responds to questions

Versioning

  • Mark pages with last update date
  • Note version if applies (e.g., "for v2.x")
  • Archive old versions

Tools

  • GitHub Wiki: Simple, version-controlled
  • MkDocs: Static site, beautiful, searchable
  • Notion: Rich formatting, collaborative
  • Confluence: Enterprise, full-featured

See ../03_11_documentation_platform/ for setup