Skip to content

Neudesic Engineering Excellence Playbook

Best Practices

Initializing search

Neudesic Engineering Excellence Playbook

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
- 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
- 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
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
- 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
Developer experience
Developer experience
Documentation
Documentation
Engineering feedback
Engineering feedback
Machine learning
Machine learning
Observability
Observability
Privacy
Privacy
- Privacy and Data
- Privacy related frameworks
Reliability
Reliability
Resources
Resources
- Templates
  Templates
  - Contributing
Security
Security
Source control
Source control
User interface engineering
User interface engineering

Best Practices

Replacing Documentation with Automation
Establishing and Managing Documentation
Creating Good Documentation

Last update: January 15, 2024

Previous Documentation

Next Replacing Documentation with Automation

Made with Material for MkDocs