Skip to content
DHCW Software Engineering Handbook
Document location
Search
GitHub
DHCW Software Engineering Handbook
GitHub
Home
Software Development Handbook
Software Development Handbook
Introduction
Development tools
Development principles
Agile delivery using Scrum
Testing
Security
User interface and accessibility standards
Documentation
Exceptions
Essential good practice checklists
Using Source Control
Using Source Control
Introduction
Use our source control systems
What to include in source control
Use Git
Establish a clear repo structure
Commit changes early and often
Write clear commit messages
Review your code
Squash commits before merging
Follow a branching strategy
Adopt trunk based development and continuous integration
Implement a versioning strategy
Keep your repo organised
Always deploy from source control
Select and configure Git clients
Exceptions
Essential good practice checklist
Organising Your Solution
Organising Your Solution
Introduction
Organise your solution to accord with our conventions
Use physical folders
Create a root folder for your solution
Provide a readme file
Create a editorconfig file
Create a source folder
Use additional sub folders for dependency layers
Use sub folders within visual studio projects
Use existing conventions for project types
Create a specification folder
Provide a test folder
Provide a documents folder
Provide a build folder
Provide a scripts folder
Provide a deploy folder
Provide an examples folder
Exceptions prove the rule
Good practice checklists
General Coding Standards
General Coding Standards
Introduction
Write clean code
Follow SOLID principles
Follow Microsoft's coding conventions
Analyse your code
Exceptions
Examples
Essential good practice checklist
T-SQL Coding Standard
T-SQL Coding Standard
Introduction
Avoid using t SQL to execute business logic
Follow these rules when using an object relational mapper ORM
General good practice
Follow out table design rules schemes and indexes
Follow our table rules columns and datatypes
Apply code analysis rules
Working with transactions
Top N and Order By
XML and JSON
Date and time
Aliases
Views
Stored procedures
Handling exceptions
Working with user defined functions UDF
Working with triggers
Permissions
Working with SQL server agent
Follow our naming rules see also table design rules
Follow our code layout rules
Code comments
Exceptions prove the rule
Examples
SQL prompt configuration
Good practice checklists
RESTful API Standards
RESTful API Standards
Introduction
General principles
Definitions
FHIR Fast Healthcare Interoperability Standards
Data classification
Open API specification
Url structure
Retrieving related data
HTTP implementation
Payload rules
JSON response payload structure
Paging
Filtering
Sorting
Compound collection operations
Naming
Error reporting
Performance and response times
Concurrency control
Handling transient faults
API gateway pattern
OWASP top 10
Secrets and certificate management
Encryption
Security headers
HTTP message caching
Authentication and authorisation
API management
Testing
Tooling
Documentation
Appendix A classifications
Essential good practice checklist
Azure DevOps Handbook
Azure DevOps Handbook
Introduction
Azure DevOps basics
Joining an existing project
Creating a new project
Adding users and Teams
Planning and tracking work with Azure boards
Managing source code with Azure repos
Automating builds and deployments with Azure pipelines
Configuring agents for Azure pipelines
Sharing code with Azure artifacts
Defining and running test cases with Azure test plans
Using wikis
Creating and managing dashboards
Managing user settings
Project housekeeping tasks
Securing your projects
Managing costs
Support and troubleshooting
Enabling GitHub Advanced Security
Connecting Defender for Cloud DevOps
Using Azure DevOps extensions
Data privacy and availability
Essential good practice checklist
Software Subscriptions
Software Subscriptions
Introduction
What subscriptions are available
Identify the subscription you need
Requesting a subscription
Cancelling a subscription
Managing subscriptions
Test Summary Report
Test Summary Report
Introduction
When to create a test summary report
Characteristics of a good test summary report
Cover page
Table of contents
Document location
Relevant documents
Version control
Reviews and approvals
Summary of testing
Test metrics
Further metrics
Filename
Layout and formatting
Example reports
Exceptions prove the rule
Testing for Lost Updates
Testing for Lost Updates
Introduction
Whats a lost update
How do you test for lost updates
Follow a risk based approach
Concurrency controls
Locking
Write and execute tests
Example test scripts
Further reading
Coding Standard Template
Coding Standard Template
Introduction
Use a brief heading to describe the standards
Exceptions prove the rule
Good practice checklists
Home
Test Summary Report
Document location
Document Location
MUST
be a hyperlink to the original document.
Back to top