Technical Standards

This is a personal collection of best practices and guidelines for software design and construction.

Read more about the role technical standards play in software development.

My technical standards are living documentation, continuously revised and extended. They’re organized by domain and licensed under CC BY-SA 4.0. You are welcome to fork the source files for your own needs.

Requirements levels

Throughout these technical standards, the capitalized words REQUIRED, MUST, MUST NOT, RECOMMENDED, SHOULD, SHOULD NOT, OPTIONAL, and MAY are to be interpreted as described in IETF RFC 2119.

Index

• TS-1 Software requirements specification
• TS-2 Software design qualities
• TS-3 Design docs
• TS-4 Modeling
• TS-5 Application architecture
• TS-6 Distributed system design
• TS-7 Code design
• TS-8 Issue tracking
• TS-9 Version control
• TS-10 Releasing
• TS-11 Versioning
• TS-12 Quality assurance
• TS-13 Functional testing
• TS-14 Performance testing
• TS-15 User interfaces
• TS-16 Command line interfaces (CLIs)
• TS-17 Graphical user interfaces (GUIs)
• TS-18 Web GUIs
• TS-19 Search engine optimization (SEO)
• TS-20 Network APIs
• TS-21 HTTP APIs
• TS-22 Webhooks
• TS-23 Messages and events
• TS-24 User manuals
• TS-25 Technical documentation
• TS-26 Technical writing style guide
• TS-27 Markdown
• TS-28 AsciiDoc
• TS-29 JSON Schema
• TS-30 YAML
• TS-31 Unix shells and POSIX standards
• TS-32 Bash
• TS-33 Java
• TS-34 PHP
• TS-35 Python
• TS-36 ECMAScript (JavaScript/TypeScript)
• TS-37 Web platform APIs
• TS-38 Node.js applications
• TS-39 HTML
• TS-40 CSS
• TS-41 React
• TS-42 Vue
• TS-43 Relational databases and SQL
• TS-44 Non-relational (NoSQL) databases
• TS-45 Data migrations
• TS-46 Distributed data and caching
• TS-47 Dates and times
• TS-48 Environment variables
• TS-49 Cloud platform engineering
• TS-50 Cloud economics
• TS-51 Amazon Web Services (AWS)
• TS-52 Security and secrets management
• TS-53 Privacy and data protection
• TS-54 Threat modeling
• TS-55 Authentication and authorization
• TS-56 JSON Web Tokens (JWTs)
• TS-57 Logging, monitoring, observability
• TS-58 Docker
• TS-59 Terraform
• TS-60 GitHub Actions
• TS-61 AI tools
• TS-62 Make
• TS-63 URL design