-
Notifications
You must be signed in to change notification settings - Fork 0
Requirements Analysis
This document outlines the functional and non-functional requirements for the Helix project. Its primary objective is to provide a clear, comprehensive, and unambiguous foundation for both the development team and stakeholders, ensuring a shared understanding of the project's goals and scope. By defining the system's features, constraints, and quality attributes, this document serves as a guide for design, implementation, and testing, and will be used to validate the final product against the initial requirements.
This document employs British English spelling and adheres to the following conventions:
- Bold text: Indicates key terms, concepts, or user interface elements.
- Italic text: Used for emphasis, titles of documents, or to introduce new terms.
-
Monospaced font: Represents code, file paths, or system output.
Requirements are categorised as either functional or non-functional and are assigned a unique identifier for traceability (e.g., FR-001, NFR-001).
This document is intended for a diverse audience, including:
- Project Stakeholders: To understand the project's vision, scope, and objectives.
- Developers: To guide the design, implementation, and testing of the software.
- Project Managers: To assist in project planning, tracking, and management.
- Quality Assurance Teams: To develop test cases and verify that the system meets the specified requirements.
It is recommended that all readers begin with the Introduction and Project Scope sections to gain a high-level understanding of the project. Subsequently, readers may focus on the specific functional and non-functional requirements relevant to their roles.
The Helix project is an open-source scaffolding solution for Java, designed to accelerate development by providing a robust, authorities-based system with essential management features. The scope of this project includes the following key functionalities:
- Department Management: To facilitate the organisation and management of departmental structures.
- Authorities Management: To define and control granular permissions and access levels.
- Position Management: To manage job roles and their associated responsibilities.
- User Management: To handle the complete lifecycle of user accounts, including creation, updates, and deletion.
- User Authentication and Authorisation: To securely verify user identities and enforce access rights across the system.
- Third-Party Office Automation (OA) System Integration: To enable seamless login with platforms such as Microsoft Teams, DingTalk, Lark, and WeCom.
Out of Scope:
- Advanced business-specific modules beyond the core management features.
- Customisation of third-party OA system integrations beyond standard authentication.