awesome-practices
Software engineering best practices 📚
https://github.com/ParanoidUser/awesome-practices
Last synced: 1 day ago
JSON representation
-
Development
- Google Cloud Architecture Framework - Provides recommendations and best practices for designing and operating a cloud topology.
- Guiding Principles of REST - Guiding principles for designing loosely coupled applications over the network.
- EKS Best Practices Guides - Set of best practices for day 2 operations for Amazon EKS.
- Google Engineering Practices - Collective experience of various best practices that were developed over time in Google.
- Google Style Guides - Complete definition of Google's coding standards for different languages.
- Best practices for writing Dockerfiles - This topic covers recommended best practices and methods for building efficient images.
- Style Guide for Protobuf - This document is meant as a short reference for developers to refer to when writing Protobuf schemas.
- Kubernetes Configuration Best Practices - Consolidates configuration best practices that are introduced throughout the user guide, Getting Started documentation, and examples.
- AWS Well-Architected - Helps cloud architects build secure, high-performing, resilient, and efficient infrastructure for a variety of applications and workloads.
- Conventional Logs - Specification for adding human and machine-readable meaning to log messages.
- Go Optimization Guide - Patterns and Techniques for Writing High-Performance Applications with Go.
-
Tools
- Typograms - Lightweight image format useful for defining simple diagrams in technical documentation.
- IP Guide - Easy to use API for looking up IP, Network, and ASN data.
- Maven Code Style and Code Conventions - Rules for how the sources should be formatted in order to improve consistency, readability, and maintainability.
- Gitignore - Web service designed to help you create .gitignore files for your Git repositories.
- Command-not-found - Helpful tool for installing any command on any operating system.
-
Security
- TLS Cipher Suite Search - Searchable directory of TLS cipher suites and related security details.
- Node.js Security Best Practices - This document intends to extend the current [threat model](https://github.com/nodejs/node/security/policy#the-nodejs-threat-model) and provide extensive guidelines on how to secure a Node.js application.
- OWASP Top 10 - Standard awareness document for developers and web application security.
-
Methodology
- Manifesto for Fluid Software Development - Defines a new approach to software development focused on fluidity and adaptability.
- Functional Documentation - Some collected thoughts and ideas around applying a functional approach to writing and maintaining documentation, especially for design systems.
- GitLab Documentation Style Guide - Standards for GitLab documentation, including grammar, formatting, word use, and more.
- Minimum Viable CD - Set of practices that give the expected improvements to organizational structure that come with continuous delivery.
- Patterns for Managing Source Code Branches - Patterns that can allow teams to use branching effectively, concentrating around integrating the work of multiple developers and organizing the path to production releases.
- Write the Docs - Collective wisdom of the Write the Docs community around best practices for creating software documentation.
- Writing Better Release Notes - Some thoughts on how to write better release notes.
- Manifesto for Agile Software Development - Outlines the central values and principles of Agile software development.
-
Data
- MLOps Principles - Best practices and tools to test, deploy, manage, and monitor ML models in real-world production.
- Transparent Telemetry - Designed to give developers the information they need to be effective without having to track detailed user activity.
-
Design
- 8 Principles of Information Architecture - Eight principles to help designers make the right decisions when creating their build strategies.
- A11Y Project - Community-driven effort to make digital accessibility easier.
- Contrast Rebellion - Multitude of accessibility problems with unreadable, low-contrast texts.
- Guide to Accessible Form Validation - Considerations, so that nobody gets stuck on an inaccessible invalid field.
- Material Design Guidelines - Usability and platform guidance describe how to make sure your app is usable for all users.
- Contrast Rebellion - Multitude of accessibility problems with unreadable, low-contrast texts.
-
Culture
- Amazon Leadership Principles - Core principles for discussing ideas for new projects or deciding the best way to solve a problem in everyday life.
- Conventional Comments - Standard for formatting comments of any kind of review/feedback process.
- Which Version of JDK Should I Use? - This site gives independent, yet opinionated recommendations.
- Hacker Laws - Laws, Theories, Principles and Patterns that developers will find useful.
- DORA Guides - Long running research program that seeks to understand the capabilities that drive software delivery and operations performance.
- Principles of Green Software Engineering - Set of competencies needed to define, build and run green software applications.
Programming Languages
Categories
Sub Categories
Keywords