Who Should Read This Engineering Handbook?

Overview

This engineering handbook is designed as a comprehensive guide for development, testing, and deployment within the Alliance Business Suite (ABS). As such, it is intended to be a resource for a wide range of roles within the ABS ecosystem.

Target Audience

Core Developers

Those who are directly responsible for adding new features, fixing bugs, and making architectural decisions in the ABS platform will find this handbook particularly useful. It will provide them with best practices, coding standards, and insights into the technologies we use.

Contributing Developers

Whether you are an open-source enthusiast or a partner company looking to integrate with ABS, this handbook will provide you with the necessary guidelines and procedures to contribute effectively.

QA Engineers

With dedicated sections on testing frameworks and procedures such as MSTest, ABS.SnapBind, and SpecFlow, Quality Assurance professionals will find guidelines on how to create robust test plans and cases.

DevOps Engineers

Professionals in charge of CI/CD pipelines, monitoring, and infrastructure — especially those who use Azure DevOps and Azure Cloud — will find invaluable advice and tutorials.

Technical Writers

Those responsible for documenting the codebase can understand the architecture and features more comprehensively, thus improving the quality and effectiveness of documentation.

Product Managers

While not directly involved in coding, understanding the technical capabilities, limitations, and best practices can help Product Managers make more informed decisions.

Business Stakeholders

High-level managers, business analysts, and other non-technical roles may find the sections on architecture and technology useful for gaining an overview understanding of the development process, which can aid in strategic planning.

Prerequisites

While the handbook is comprehensive, it assumes a certain level of knowledge in areas such as:

  • .NET 7.0, Node.js, React+Redux, TypeScript, and Bootstrap
  • Azure DevOps and Azure Cloud
  • Database management systems like MySQL, MSSQL, PGSQL, ORACLE, and MongoDB
  • MSTest and SpecFlow for testing
  • Vault for secrets management
  • Plesk for web hosting
  • PowerShell scripting

Concluding Remarks

This handbook is a living document; as technologies and best practices evolve, so too will the content of this guide. Therefore, feedback and contributions from readers like you are invaluable for keeping it relevant and up-to-date.