https://github.com/unixorn/chocolate-factory-engineering-docs

A collection of hopefully useful document templates for engineering orgs
https://github.com/unixorn/chocolate-factory-engineering-docs

chocolate-factory design-document engineering engineering-docs engineering-orgs hooli hooli-infrastructure incident monitoring

Last synced: 2 months ago
JSON representation

A collection of hopefully useful document templates for engineering orgs

• Host: GitHub
• URL: https://github.com/unixorn/chocolate-factory-engineering-docs
• Owner: unixorn
• License: apache-2.0
• Created: 2018-12-18T19:11:11.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-08-20T20:11:40.000Z (9 months ago)
• Last Synced: 2025-01-29T09:22:24.741Z (4 months ago)
• Topics: chocolate-factory, design-document, engineering, engineering-docs, engineering-orgs, hooli, hooli-infrastructure, incident, monitoring
• Homepage:
• Size: 43 KB
• Stars: 48
• Watchers: 8
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Table of Contents

- [Engineering-docs](#engineering-docs)

# Engineering-docs

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Funixorn%2Fchocolate-factory-engineering-docs%2Fbadge%3Fref%3Dmain&style=flat)](https://actions-badge.atrox.dev/unixorn/chocolate-factory-engineering-docs/goto?ref=main)

[![GitHub last commit (main)](https://img.shields.io/github/last-commit/unixorn/engineering-docs/main.svg)](https://github.com/unixorn/chocolate-factory-engineering-docs)

A collection of hopefully useful document templates for engineering orgs.

* [Alert Requirements](https://github.com/unixorn/chocolate-factory-engineering-docs/blob/master/Alert_Requirements.md) - A brief set of guidelines for creating alerts.

* [Engineering Design Document Template](https://github.com/unixorn/chocolate-factory-engineering-docs/blob/master/Engineering_Design_Document.md) - An engineering project design document template inspired by one of the internal ones I saw in the chocolate factory.

* [Monitoring Guidelines](https://github.com/unixorn/chocolate-factory-engineering-docs/blob/master/Monitoring-Guidelines.md) - A brief list of guidelines for good monitoring dashboards.

* [Safe Data Handling During Incidents](https://github.com/unixorn/chocolate-factory-engineering-docs/blob/master/Safe_Data_Handling_During_Incidents.md) - A short list of guidelines to keep in mind during incident response.