Technology Partnership and Engineering Guidelines Outline
Comprehensive set of guidelines and standards tailored for a web project.
Technology Partner Profile
Introduction and Context What We Are Looking For Context
Non-Functional Requirements Key Technology Choices (Decision Log)
Cloud Provider Programming Languages Third Party Services Infrastructure as Code (IaC) API First Managed Services Serverless Compute Database Monitoring DevOps and Tooling Frontend Framework Frontend: BFF Pattern, RESTful APIs, GraphQL Package Manager CI/CD Stages Engineering SOP (Standard Operating Procedure)
Code Reviews/Code Changes/Tracking Architecture Decision Records (ADR) Engineering Design Documents (EDD) Rollback, Revert, Fix Post-Incident Review, Post-Mortem Code Standards
Typescript, Eslint Code Formatting Naming Conventions & Standards Code Organization Test Coverage CI/CD Stages, Naming and Purpose
Sandbox Development Testing Staging Production Product Specs, Roadmap & Milestones
Project Management & Collaboration Tooling
Project Management Tool Appendix (To Be Deleted)
To Add: Monitoring Set Up (if not on our side)
Created on 5/23/2024