Overview

Authors:

Brad Stancel

Created:

04/01/2020

Modified:

09/19/2025

This documentation site and corresponding Git repository is meant to help document and explain the documentation system and methodology I use both personally and professionally.

The key features and benefits that it needed to possess are as follows:

  1. Be portable and not locked in to one software or company - ideally text based

  2. Able to be version controlled - ideally using Git

  3. Have the ability to produce different outputs from the same content. Examples:

    • HTML

    • PDFs

    • ePubs

    • XML

    • etc

  4. Handle diagrams, workflows and directed graphs that are text based

  5. Embed YouTube, code snippets, configuration and other snippets