Search This Blog

Technical Design Document Template

  • Application High-level Overview
  • Architecture
    • Physical Architecture
    • Logical Architecture
    • Deployment Architecture
    • Microservice Communication Architecture
    • Architecture Pattern
      • TDD | BDD
      • Dependency Injection
      • Event based Architecture

    • Use Case View
      • Use Case 1
        • Flow Diagram
        • Sequence Diagram
        • Interface details
      • Use Case 2
      • Use Case 3
      •  
      •  
      •  
  •  DevOps
    • Repository configuration
      • NPM
      • Helm
      • Git
      • Nuget
      • Docker
    • Project Structure (folder /branch structure, Git flow details etc)
    • Repository structure
      • Git flow
    • Microsoft Build Time validation Rules
    • Source Code Repositories
    • Branch Policies
    • Build Quality Control
      • Build Policies
    • Release Quality Control
      • Release Policies
    • Build pipelines
    • SonarQube server & Task configuration in build pipelines
    • BDH Integration
    • Environment Release pipelines
      • Dev
      • QA
      • Prev
      • Prod

    • Technologies Used
      • Frontend
        • Angular
        • Redux
        • SASS
      • Backend
        • Dotnet Core, C#, LINQ, EF
        • Docker
        • Kubernetes
        • Helm
    • Security Considerations
      • Threat Modeling
        • reference of threat model
        • out of scope items
      • CVSS
      • OWASP Top 10
      • CheckMarks Scan
      • Black Duck Analysis
      • Data Security
        • Rest
          • Database
          • Application
        • Transit
          • Application ports
      • Penetration testing
    • Privacy Considerations
      • GDPR
    • Compliance considerations
      • ISO 9000
      • PCI /DSS
      • HIPPA
      • CFR Part 11
    • Required Project Training
      • Technology Training
        • Getting started with Docker
        • Kubernetes administration
        • Azure Web Development
        • Understanding Helm repo & commands
      • Security Training
        • Secure Development process
        • Owasp Top 10
        • Threat Modeling
      • Safety Training
      • Process Training
    • Non-Functional Requirements
      • Logging
      • Monitoring
      • High Availability
      • Disaster Recovery
      • Application Performance
      • Auditing
      • Backup
      • SLA
      • Internationalization/Localization
    • Naming & Style convention and control
      • Validate and ensure naming convention rules by applying appropriate policies using MS build rules 
      • Codelyzer for angular
      • TSLint
    • Code quality control
      • SonarQube
      • MS Build Rules
      • npm audit
    • High Availability Considerations
    • Disaster Recovery Considerations
    • Harding Network Communication
      • Define Firewall
      • NSG Security rules
      • IP Whitelisting
      • Harding Database communication
    • Infrastructure Audit
    • Unit Testing