Engineering Playbook

Company Engineering Playbook (living docs-as-code)

Overview

This repository contains our engineering team's playbook - a living documentation of our processes, standards, and best practices.

Structure

• docs/ - Markdown chapters containing our engineering documentation
• templates/ - Reusable templates (RFCs, PR checklists, research worksheets)
• scaffolds/ - Repository skeletons and project templates
• snippets/ - Helper code snippets and utilities
• .github/ - GitHub workflows and templates

Documentation Site

This playbook is built using MkDocs. To run locally:

pip install mkdocs mkdocs-material
mkdocs serve

Contributing

All team members are encouraged to contribute to this playbook. Please submit pull requests for any additions or improvements.

License

This project is licensed under the MIT License - see the LICENSE file for details.