Introduction
Purpose
Describes the Application Development and Support Directorate's standard for organising your software solution.
Scope
Software Developers have a responsibility to follow this guide.
Developers targeting frameworks other than .NET may need to make sensible adjustments where necessary.
References
Conventions
The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in RFC 2119.
Practical tips
Practical tips
Examples of good practice
Examples of good practice...
Practices to avoid
...and practices to avoid
Further reading and information
Links to further guides, information and work instructions
Note that all links to Microsoft Learn© may default to Azure DevOps Services. Use its version selector to tailor the website for Azure DevOps Server.
The need for guidance
Modern programming practices expect us to prove that our code meets functional requirements and can be reliably built and deployed.
This requires a little forethought when creating a solution that others will use (often without the originating developer present.) So, it's critical we create software solutions that are:
-
Clear and explicit
-
Understandable by developers of all abilities
-
Safely extensible & well documented
The following sections provide guidance on how we can achieve this.