Skip to main content

Documentation module overview

The Docs module provides one searchable source of truth for Skunkworks Academy platform, delivery, support, governance, and publishing documentation.

Design principles

  1. One canonical page per subject. Link to the authoritative page rather than duplicating procedures.
  2. Task-oriented structure. Pages should help a reader complete a task, make a decision, or understand a system boundary.
  3. Versioned change control. Material changes are reviewed through pull requests and validated by the documentation build.
  4. Secure by default. Never publish credentials, tenant secrets, learner personal information, or internal-only operational data.
  5. Accessible delivery. Use semantic headings, descriptive links, alt text, keyboard-safe interactions, and plain language.

Primary sections

  • Getting started and contribution guidance
  • Learning delivery and laboratory operations
  • Platform architecture and service ownership
  • Publishing and content lifecycle procedures
  • Security, accessibility, and governance standards
  • Module directory and support references