Maintainability

Here you will find all tactics for the quality characteristic Maintainability.

Tactics (73)

Modularity

Also supports: Analyzability, Appropriateness

Domain-Driven Design

Structure software architecture based on the business domain

#UbiquitousLanguage #BoundedContexts #AggregateDesign

Modularity

Also supports: Modifiability, Testability

Separation of Concerns

Divide functionalities into clearly defined, independent areas

#ModularDesign #SingleResponsibilityPrinciple #ComponentBasedDevelopment

Modularity

Also supports: Reusability, Testability

Modularization

Divide application into small, independent, and reusable components

#ComponentBasedDevelopment #LooseCoupling #InterfaceDesign

Analyzability

Bubble Context

Clearly distinguish extensions from existing code parts

#BubbleContext #DomainDrivenDesign #BoundedContext

Modularity, Analyzability

Also supports: Modifiability, Reusability

Modulith

Structure system architecture into independent, interchangeable modules

#ModularArchitecture #ModuleBoundaries #IndependentDevelopment

Modularity

Also supports: Modifiability, Analyzability, Replaceability

Layered Architecture

Divide software system into logical layers with clear responsibilities

#NTierArchitecture #SeparationOfConcerns #LayeredDesign

Reusability

Also supports: Modifiability, Analyzability

Pattern Language

Apply proven solution patterns for recurring design problems

#PatternLanguage #ConceptualIntegrity #CrossCuttingConcepts

Analyzability

Also supports: Modularity, Interoperability

Anti Corruption Layer

Decouple the internal design and logic of a system from external influences

#ACL #DomainDrivenDesign #CoherentDesign #SystemIntegration

Analyzability

Also supports: Modifiability, Capacity

Architecture Reviews

Review software architecture systematically and regularly

#ArchitectureGovernance #SoftwareReviews #StrategicArchitecture

Modifiability

Also supports: Appropriateness, Testability

Walking Skeleton

Develop a minimal, running system with the core architectural ideas

#AgileArchitectureWork #IncrementalDevelopment #WalkingSkeleton #VerticalPrototype

Modifiability

Also supports: Maturity, Testability

Technical Spike

Validate that an architecture will remain maintainable under expected growth

#ArchitectureExploration #Spike #TechnicalValidation #DecisionMaking #VerticalPrototype

Analyzability, Modifiability

Clean Code

Structure source code according to established principles for readability and maintainability

#CleanCode #CodeQuality #Readability

Modularity

Also supports: Modifiability, Reusability

SOLID Principles

Apply fundamental design principles for object-oriented programming

#ObjectOrientedDesign #DesignPrinciples #DesignPatterns

Modifiability, Analyzability

Refactoring

Restructure code regularly without changing external behavior

#ContinuousRefactoring #CodeCleaning

Modifiability, Analyzability

Refactoring Katas

Perform regular exercises to improve code quality

#Refactoring #Katas #CodeQuality

Analyzability

Also supports: Testability, Integrity

Static Code Analysis

Review source code automatically for potential issues

#CodeQuality #AutomatedCodeReview #ErrorPrevention

Analyzability

Also supports: Modifiability, Integrity, Correctness

Code Reviews

Review source code systematically through peer feedback

#PeerReview #PullRequests

Analyzability

Also supports: Modifiability

Strategic Code Deletion

Remove superfluous or obsolete code from the codebase

#Rightsizing #CodeReduction #TechnicalDebtReduction

Analyzability, Modifiability

Also supports: Co-existence

Deprecation Strategy

Systematically mark and gradually remove deprecated features

#FeatureDeprecation #CodeDeletion #ComplexityReduction

Analyzability, Modifiability

Also supports: Testability

Ensemble Programming

Solve complex design and debugging challenges as a group

#EnsembleProgramming #MobProgramming #PairProgramming #KnowledgeSharing

Analyzability

Also supports: Testability, Integrity

Pair Programming

Two developers work together on a task at one workstation

#CollaborativeDevelopment #KnowledgeSharing #CodeQuality

Modifiability

Also supports: Analyzability, Testability

Open Development Practices

Improve code quality through public code review, transparent issue tracking, and external contributions

#OpenDevelopment #PublicCodeReview #ExternalContributions #FairSource

Analyzability

Also supports: Modifiability

Code Conventions

Define and enforce uniform guidelines for code formatting and structure

#CodingStandards #Linting #Consistency

Analyzability

Also supports: Testability

Code Metrics

Collect and analyze quantitative code quality measures

#StaticCodeAnalysis #QualityControl #ContinuousImprovement

Analyzability

Code Quality Gates

Ensure code quality through standardized, automated checks

#CodeQuality #QualityAssurance #QualityManagement

Testability

Also supports: Modifiability, Fault Tolerance

Automated Tests

Automatically conduct and regularly execute software tests

#AutomatedTests #TestAutomation #ContinuousTesting

Testability

Also supports: Fault Tolerance, Interoperability

Integration Tests

Conduct tests to verify the interaction of different system components

#SystemTests #IntegrationTests #QualityAssurance

Testability

Also supports: Modifiability, Fault Tolerance

Test-Driven Development (TDD)

Write tests before the actual implementation

#TestAutomation #AgileDevelopment #QualityAssurance

Testability

Also supports: Completeness, Operability

Behavior-Driven Development (BDD)

Develop based on expected system behaviors

#AcceptanceTesting #Gherkin #SpecificationByExample

Testability

Also supports: Modifiability, Availability

Code Coverage Analysis

Measure the proportion of code covered by tests

#TestAutomation #TestCoverage #QualityMetrics #ContinuousTesting

Modularity

Also supports: Testability, Reusability

Dependency Injection

Manage and inject dependencies between components externally

#InversionOfControl #LooseCoupling #Testability

Modularity

Also supports: Modifiability, Testability

Dependency Injection Container

Manage and provide dependencies centrally via a container

#InversionOfControl #LooseCoupling #DependencyManagement

Modifiability

Also supports: Maturity, Integrity, Availability

Dependency Management

Systematize the management and updating of external dependencies

#DependencyManagement #LibraryManagement #VersionControl

Modifiability, Testability

Also supports: Availability

Continuous Integration

Integrate code changes regularly into a shared repository

#ContinuousIntegration #AutomatedBuilding #AgileDevelopment

Modifiability

Also supports: Testability, Analyzability

Short Iteration Cycles

Force incremental, maintainable design through time-boxed delivery cycles

#ShortIterations #IncrementalDesign #TimeboxedDelivery #Scrum #Kanban

Analyzability

Also supports: Modifiability

Architecture Workshops

Conduct regular workshops to evolve the software architecture

#ArchitectureWorkshops #arc42 #ArchitectureEvolution

Analyzability

Also supports: Modifiability, Reusability

Architecture Review Board

Establish a committee for architectural oversight and governance

#ArchitectureGovernance #StrategicArchitecturePlanning

Modularity

Also supports: Reusability

Architecture Governance

Define and enforce architectural principles and best practices

#ArchitecturGovernance #ConsistentDevelopment #ConceptualIntegrity

Analyzability

Architecture Conformity Analysis

Check the alignment of the software architecture with defined architectural principles

#ArchitectureConformity #ArchitectureValidation

Analyzability

Also supports: Interoperability

Fitness Functions

Verify compliance with architectural guidelines continuously

#ArchitectureCompliance #FitnessFunctions #EvolutionaryArchitecture

Modifiability

Also supports: Capacity

Architecture Roadmap

Plan and manage architecture development long-term

#StrategicArchitecturePlanning #TechnologyRoadmap #LongTermDevelopment

Modifiability

Also supports: Analyzability, Testability

Version Control

Systematically track and manage changes to the source code

#Git #Branching #MergeManagement

Modifiability

Also supports: Testability, Availability

Feature Toggles

Enable or disable functions through configuration switches

#FeatureFlags #ContinuousDeployment #RiskMinimization

Analyzability, Testability

Also supports: Availability

Logging

Implement comprehensive logging and monitoring of system behavior

#Logging #ErrorDiagnosis

Analyzability

Also supports: Modifiability

Knowledge Management System

Collect and distribute knowledge about the software project centrally

#KnowledgeBase #CollaborativeDocumentation #OrganizationalLearning

Analyzability, Modifiability

Architecture Documentation

Create and maintain detailed documentation of the software architecture

#ArchitectureDocumentation #arc42 #C4 #ArchitectureDiagrams

Analyzability

Also supports: Modifiability

Architecture Decision Records (ADR)

Document important architectural decisions and their justifications

#ADRs #DecisionTransparency #LongTermDocumentation

Analyzability

Also supports: Modifiability, Testability

Living Documentation

Keep documentation current and accessible as part of development

#DocumentationAsCode #AutomaticDocumentationGeneration #KnowledgeManagement

Analyzability

Also supports: Modifiability, Reusability

Docs as Code

Treat and manage documentation like source code

#DocsAsCode #LivingDocumentation #ContinuousDocumentation

Modularity

Also supports: Interoperability, Reusability

API-First Design

Define and design interfaces before implementing application logic

#APIDesign #ContractFirstDevelopment

Analyzability

Also supports: Learnability, Interoperability

API Documentation

Describe interfaces and their usage in detail

#OpenAPI #DeveloperExperience

Analyzability

Also supports: Modifiability, Reusability

Code Comments

Enhance code with meaningful comments and documentation blocks

#CodeComments #SelfDocumentingCode #DeveloperOnboarding

Analyzability

Also supports: Modifiability, Operability

Fluent Interfaces

Design APIs with natural language-like method chaining

#APIDesign #MethodChaining #Readability

Testability

Also supports: Modifiability, Availability

Mutation Testing

Test the robustness of software tests through targeted code changes

#TestQuality #CodeCoverage #FaultInjection

Testability

Also supports: Modifiability, Availability

Property-Based Testing

Verify software through random inputs and properties

#GenerativeTesting #RandomizedTesting #RobustnessTests

Modularity

Also supports: Modifiability, Reusability

Aspect-Oriented Programming (AOP)

Separate cross-cutting concerns from the main functionality

#CrossCuttingConcerns #ModularExtensibility #SeparationOfConcerns

Modifiability

Also supports: Testability, Correctness

Code Generation

Generate code automatically from templates or metadata

#Automation #BoilerplateReduction #Metaprogramming

Modifiability

Also supports: Availability

Continuous Delivery

Prepare software changes automatically for production deployment

#DevOps #Automation #ControlledDeployment

Modifiability

Also supports: Availability, Completeness

Continuous Deployment

Deploy software changes fully automatically into production

#ContinuousDeployment #FullyAutomatedDeployment #NoHumanIntervention

Modularity

Also supports: Modifiability

Microservices

Divide the application into small, independent services

#Microservices #DistributedArchitecture #ServiceOrientation

Modifiability

Also supports: Installability

Containerization

Encapsulate applications and their dependencies in containers

#Containerization #Docker #Portability

Modifiability, Reusability

Also supports: Fault Tolerance

Infrastructure as Code

Define and manage infrastructure through code

#InfrastructureAsCode #IaC #AutomatedInfrastructure

Modularity, Modifiability

Loose Coupling

Minimize dependencies between modules so changes don't cascade

#LooseCoupling #InterfaceDesign #DependencyReduction

Modularity, Analyzability

High Cohesion

Ensure each module serves a focused, well-defined purpose

#HighCohesion #SingleResponsibility #ModuleDesign

Testability, Modifiability

Also supports: Modularity

Hexagonal Architecture

Isolate business logic from infrastructure through ports and adapters

#HexagonalArchitecture #PortsAndAdapters #CleanArchitecture

Modularity, Modifiability

Also supports: Reusability

Event-Driven Architecture

Decouple components through asynchronous events

#EventDriven #PublishSubscribe #DomainEvents

Modifiability, Reusability

Strangler Fig Pattern

Replace legacy systems incrementally by routing traffic to new implementations

#StranglerFig #LegacyModernization #IncrementalMigration

Analyzability

Also supports: Testability

Observability

Implement structured logging, distributed tracing, and metrics

#Observability #OpenTelemetry #DistributedTracing

Testability, Modularity

Also supports: Modifiability

Contract Testing

Verify service interfaces conform to agreed contracts

#ContractTesting #ConsumerDrivenContracts #Pact

Modifiability, Testability

Trunk-Based Development

Integrate short-lived branches continuously into main

#TrunkBasedDevelopment #ContinuousIntegration #BranchingStrategy

Modifiability

Also supports: Analyzability

Evolutionary Database Design

Evolve database schemas incrementally through version-controlled migrations

#DatabaseMigration #SchemaEvolution #ExpandAndContract

Modifiability, Analyzability

Technical Debt Management

Identify, track, and prioritize technical debt systematically

#TechnicalDebt #CodeQuality #DebtBacklog

Anything missing? Propose a new quality tactic →