microsoft/code-with-engineering-playbook

Features

• Software Engineering Standards - Serves as a comprehensive collection of standardized guidelines and processes for the full software development lifecycle.
• Technical Documentation - Implements consistent formatting and organization standards for repositories and APIs to ensure reliable knowledge sharing.
• Static-Site-Based Documentation - Implements a technical content pipeline using Git for versioning and static site generation for deployment.
• API Documentation Generators - Produces programming guides and specifications automatically using specialized comments on types and members.
• Container Development Environments - Standardizes contributor toolchains and development setups using virtualized container environments.
• Containerized Development Environments - Provides standardized contributor environments by packaging the entire development stack within virtualized containers.
• Version-Controlled Documentation - Manages technical content using source control and pull requests to facilitate peer reviews and auditability.
• Containerized Development Environments - Standardizes contributor environments and toolchains through the use of virtualized containers.
• Git-Based - Manages technical documentation and wiki pages using Git-based version control to track changes and peer reviews.
• Implementation Frameworks - Defines a framework for implementing core requirements for accessibility, security, and continuous delivery.
• Interface Modeling Languages - Defines service interfaces using a shared modeling language to automate client library and documentation generation.
• Agile Project Management - Provides a structured framework and methodologies for organizing work cycles and delivery timelines using agile project management.
• API Design Patterns - Establishes language-agnostic patterns for defining HTTP service interfaces and automating client library generation.
• API Design Standards - Provides guidelines and processes for enforcing consistent API design patterns across multi-team developments.
• API Specification Definitions - Implements standardized processes for defining HTTP service interfaces to automate documentation and client library generation.
• Architecture Decision Records - Uses structured templates for capturing architecture decision records and trade studies to preserve technical context.
• Contribution Workflows - Defines standardized rules for branching, commits, and pull requests to maintain project history.
• Agile Workflows - Organizes development work through iterative sprints and backlogs for incremental delivery.
• Engineering Best Practices - Provides a framework of curated development guidelines to increase software quality across the lifecycle.
• Language-Agnostic APIs - Utilizes language-agnostic API specifications to automate the generation of client libraries and documentation.
• Project Documentation Standards - Defines a consistent set of required documentation artifacts for repositories, commit messages, and APIs.
• Technical Foundation Standards - Establishes standardized requirements and benchmarks for security, observability, and testing to ensure consistent system scalability.
• Markdown Formatting - Enforces consistent formatting and style rules across markdown documents using static analysis tools.
• Bug Tracking Systems - Provides a standardized process for capturing and managing software defects with reproduction steps and severity levels.
• Documentation Style Standards - Applies linguistic and structural style guidelines and review checklists to ensure clear technical writing.
• Documentation Generators - Automates the creation of technical guides by extracting information from source code comments.
• Documentation Site Hosting - Generates static documentation sites and uploads them to cloud hosting services for public accessibility.
• Document Quality Validations - Automates documentation quality maintenance through integrated validation tools and real-time notifications.
• Versioned Wikis - Implements a version-controlled wiki system that allows multiple contributors to collaborate on project information.
• Wiki Mirroring - Synchronizes wiki content between repositories using git remotes to ensure a secondary backup and consistent knowledge base.
• Static Documentation Generation - Provides a system to transform text-based source files into searchable technical documentation sites.
• Static Site Generation - Transforms raw markdown files into a structured documentation website via automated build pipelines.
• Wiki Content Mirroring - Synchronizes documentation across multiple repositories using git remotes to ensure a single source of truth.
• Documentation Link Checkers - Includes automated tools to scan documentation for broken external hyperlinks and orphaned media.
• Pull Request Templates - Uses metadata templates for pull requests to ensure consistent inclusion of descriptions and linked work items.
• Cross-Repository Content Synchronization - Provides a method for mirroring wiki pages across repositories to maintain shared guidelines in a single source of truth.
• Work Item Definitions - Provides standardized attributes and schemas for stories and tasks to ensure shared understanding of scope.
• Hierarchies - Defines a tiered organizational system for grouping work items into epics and features for business deliverables.
• Declarative Infrastructure Provisioning - Defines hardware and network settings for documentation hosting infrastructure using automated declarative scripts.
• Static Site Deployments - Provides an automated pipeline for building static websites and pushing output to hosting providers.
• Code Documentation Standards - Establishes a practice for explaining complex implementation reasoning through internal code documentation.
• Team Operating Agreements - Establishes formal communication norms and shared definitions of done to align team expectations.
• Feedback & Issue Standards - Defines requirements for actionable details and reproduction assets in technical reports and issue tracking.
• Pre-Commit Quality Checks - Integrates automated linting, link validation, and grammar checks as pre-commit quality guardrails.

Star history