Skip to content
Neudesic Engineering Excellence Playbook
Maintainability
Initializing search
GitHub
Neudesic Engineering Excellence Playbook
GitHub
Engineering Excellence Playbook
Engineering Fundamentals Checklist
Who We Are
Structure of a Sprint
Accessibility
Accessibility
Agile development
Agile development
Advanced topics
Advanced topics
Backlog management
Backlog management
External Feedback
Minimalism Slices
Risk Management
Collaboration
Collaboration
How to add a Pairing Custom Field in Azure DevOps User Stories
Effortless Pair Programming with GitHub Codespaces and VSCode
Social Question of the Day
Engagement Team Development
Virtual Collaboration and Pair Programming
Why Collaboration
Effective organization
Effective organization
Delivery Plan
Scrum of Scrums
Team agreements
Team agreements
Definition of Done
Definition of Ready
Team Manifesto
Sections of a Working Agreement
Basics
Basics
Backlog Management
Backlog Management
Ceremonies
Ceremonies
Roles
Roles
Sprints
Sprints
Core expectations
Core expectations
Automated testing
Automated testing
CDC testing
CDC testing
End-to-end testing
End-to-end testing
Unit vs Integration vs System vs E2E Testing
E2E Testing Methods
Recipes
Recipes
Gauge Framework
Postman Testing
Fault injection testing
Fault injection testing
Integration testing
Integration testing
Performance testing
Performance testing
Performance Test Iteration Template
Load Testing
Shadow testing
Shadow testing
Smoke testing
Smoke testing
Synthetic monitoring tests
Synthetic monitoring tests
Tech specific samples
Tech specific samples
Azdo container dev test release
Azdo container dev test release
Blobstorage unit tests
Blobstorage unit tests
Templates
Templates
~Customer Project~ Case Study
Insert Test Technique Name Here
Unit testing
Unit testing
Example: Authoring a unit test
Custom Connector Testing
Mocking in Unit Tests
Test-Driven Development Example
Why Unit Tests
UI testing
UI testing
Code reviews
Code reviews
Common issues
FAQ
Inclusion in Code Review
[Work Item ID](./link-to-the-work-item)
Pull Requests
Maximizing the Effectiveness of Code Reviews
Sample code review session outline
Code Review Tools
Evidence and measures
Evidence and measures
Process guidance
Process guidance
Author Guidance
Reviewer Guidance
Recipes
Recipes
YAML(Azure Pipelines) Code Reviews
Bash Code Reviews
C# Code Reviews
Go Code Reviews
Java Code Reviews
JavaScript/TypeScript Code Reviews
Markdown Code Reviews
Python Code Reviews
Terraform Code Reviews
Continuous delivery
Continuous delivery
Azure DevOps
DevOps provider recipes
DevOps provider recipes
Github actions
Github actions
Runtime variables
Runtime variables
GitOps
GitOps
Deploying
Deploying
Secret management
Secret management
Azure DevOps: Managing Settings on a Per-Branch Basis
Secrets rotation of environment variables and mounted secrets in pods
Low code solutions
Low code solutions
Recipes
Recipes
Github workflows
Github workflows
Terraform
Terraform
Save terraform output to a variable group (Azure DevOps)
Sharing Common Variables / Naming Conventions Between Terraform Modules
Guidelines on Structuring and Testing the Terraform Configuration
Secrets management
Secrets management
Continuous integration
Continuous integration
CI in data science
CI in data science
Working with notebooks
Working with notebooks
DevSecOps
DevSecOps
Azure devops
Azure devops
Azure DevOps Service Connection Security
Dependency container scanning
Dependency container scanning
Penetration testing
Penetration testing
Secret management
Secret management
Credential Scanning
Secrets Rotation
Static Code Analysis
Recipes
Recipes
Running detect-secrets in Azure DevOps Pipelines
Credential Scanning Tool: detect-secrets
Dev conainters
Dev conainters
Markdown linting
Markdown linting
Design
Design
Design
Design patterns
Design patterns
Cloud Resource Design Guidance
Data and DataOps Fundamentals
Distributed System Design Reference
Network Architecture Guidance for Azure
Network Architecture Guidance for Hybrid
Non-Functional Requirements Capture
Object-Oriented Design Reference
REST API Design Guidance
Design reviews
Design reviews
Decision log
Decision log
Doc
Doc
Decision Log
Adr
Adr
1. Record architecture decisions
2. App-level Logging with Serilog and Application Insights
Examples
Examples
Memory
Memory
Decision Log
Architecture
Architecture
Data Model
Deployment
Deployment
Application Deployment
Trade Studies
Trade Studies
Trade Study: GitOps
Recipes
Recipes
Async Design Reviews
Incorporating Design Reviews into an Engagement
Engineering Feasibility Spikes: identifying and mitigating risk
Your Feature or Story Design Title Here (prefix with DRAFT/WIP to indicate level of completeness)
High Level / Game Plan Design Recipe
Milestone / Epic Design Review Recipe
Your Milestone/Epic Design Title Here (prefix with DRAFT/WIP to indicate level of completeness)
Preferred Diagram Tooling
Spike: {Name}
Your Task Design Title Here (prefix with DRAFT/WIP to indicate level of completeness)
Technical Spike
Trade studies
Trade studies
Trade Study Template
Diagram types
Diagram types
Design diagram templates
Design diagram templates
Class Diagrams
Component Diagrams
Deployment Diagrams
Sequence Diagrams
Exception handling
Exception handling
Exception handling
Sustainability
Sustainability
Sustainable Software Engineering
Disclaimers
Sustainable Principles
Developer experience
Developer experience
Separating client apps from the services they consume during development
Copilots
Cross Platform Tasks
Dev Containers: Getting Started
Executing pipelines locally
Fake Services Inner Dev Loop
Dev Containers: Going further
Onboarding Guide Template
Toggle VNet on and off for production and development environment
Documentation
Documentation
Best practices
Best practices
Replacing Documentation with Automation
Establishing and Managing Documentation
Creating Good Documentation
Guidance
Guidance
Code
Engineering Feedback
Projects and Repositories
Pull Requests
REST APIs
Work Items
Recipes
Recipes
Deploy the DocFx Documentation website to an Azure Website automatically
How to create a static website for your documentation based on mkdocs and mkdocs-material
How to Sync a Wiki between Repositories
Using DocFx and Companion Tools to generate a Documentation website
Tools
Tools
How to Automate Simple Checks
Integration with Teams/Slack
Languages
Wikis
Engineering feedback
Engineering feedback
Engineering Feedback Examples
Engineering Feedback Frequently Asked Questions (F.A.Q.)
Engineering Feedback Guidance
Machine learning
Machine learning
Data Exploration
Generic Envisioning Summary
Model Experimentation
Feasibility Studies
ML Fundamentals Checklist
ML model production checklist
Envisioning and Problem Formulation
Profiling Machine Learning and MLOps Code
Agile Development Considerations for ML Projects
Proposed ML Process
Testing Data Science and MLOps Code
TPM considerations for Machine Learning projects
Responsible AI in Neudesic Engineering Excellence
Observability
Observability
Guidance for Alerting
Recommended Practices
Correlation IDs
Diagnostic tools
Logs vs Metrics vs Traces
Guidance for Privacy
Observability in Microservices
Observability in Machine Learning
Observability as Code
Observability for Azure Databricks
Observability of CI/CD Pipelines
Things to Watch for when Building Observable Systems
Profiling
Recipes
Pillars
Pillars
Dashboard
Logging
Metrics
Tracing
Tools
Tools
Kubernetes UI Dashboards
Open Telemetry
Prometheus
Loki
Privacy
Privacy
Privacy and Data
Privacy related frameworks
Reliability
Reliability
Resources
Resources
Templates
Templates
Contributing
Security
Security
Rules of Engagement
Overview
Threat Modeling
Source control
Source control
Component Versioning
Merge strategies
Naming branches
Working with Secrets in Source Control
Git guidance
Git guidance
Using Git LFS and VFS for Git introduction
User interface engineering
User interface engineering
Maintainability
Recommended Technologies
Stability
Usability
Maintainability
Coming soon!
Last update:
November 10, 2021