Đặc tả phần mềm

[DucHien0643]

Tiến hành viết đặc tả phần mềm theo template có sẵn:

• [x] Task1: Introduction
• [x] Task2: Overall Description
• [x] Task3: System Features
• [x] Task4: External Interface Requirements
• [x] Task5: Other Nonfunctional Requirements
• [x] Task6: Other Requirements
• [x] Task7: Tổng hợp các nội dung trên vào file doc

[DucHien0643]

Task1: Introduction

1. Purpose The purpose of developing a Dashboard to display information from an API is to provide users with an efficient and user-friendly way to visualize and interact with data obtained from an API. By presenting data in a clear and organized manner, the Dashboard can help users quickly and easily understand key insights, identify trends, and make informed decisions. Additionally, the Dashboard can be customized to meet the specific needs of different users or user groups, allowing for a personalized and tailored experience. Ultimately, the development of such a Dashboard can improve the overall usability and effectiveness of the system or application that the API serves, leading to increased user satisfaction and engagement.
2. Document Conventions This SRS follows standard documentation conventions, such as using clear and concise language, and following a consistent structure throughout the document. Priority levels are indicated for each requirement statement, with higher-level requirements assumed to be inherited by detailed requirements unless explicitly stated otherwise. No special fonts or highlighting have been used in this document.
3. Intended Audience and Reading Suggestions The document is intended for developers, project managers, and testers preeminent, but also for marketing staff and users who need to understand the requirements of the software. The SRS is organized into several sections and provides a detailed description of the software requirements. The recommended reading sequence varies depending on the reader type, but it is suggested that developers start with the functional requirements section, project managers start with the introduction and overview sections, testers focus on the performance requirements section, users and marketing staff review the introduction, overview, and user requirements sections, and documentation writers read the entire document to ensure accurate documentation.
4. Project Scope The project scope includes the development of a Dashboard application, which will retrieve data from an API and display it in a visual format. The software will include features such as customizability, data source selection, and various types of visualizations.
5. References Wikipedia

[DucHien0643]

Task2: Overall Description

1. Product Perspective In the project "Developing a Dashboard to Display Information from an API", the product being specified is a new, self-contained product. It is not a replacement for any existing system, nor is it part of a larger system. The product is intended to provide users with a dashboard that displays real-time information obtained from an API. The application will be designed to be compatible with various data sources and will not be dependent on any specific hardware or software. It will be developed as a web application and will be accessible via a web browser.

2. Product Features The Dashboard development project will include the following major features:

   • Data visualization: The Dashboard will display data from an API in a user-friendly and interactive manner, using various charts and graphs.
   • Real-time updates: The Dashboard will be updated in real-time, allowing users to see the latest data as it becomes available.
   • Customization: The Dashboard will allow users to customize the view and select which data points to display.
   • Integration: The Dashboard will be able to integrate with various APIs and data sources.
   • User authentication: The Dashboard will require user authentication to access and view data.
   • Exporting data: The Dashboard will allow users to export data in various formats such as CSV or PDF.
   • Data filtering and searching: The Dashboard will allow users to filter and search data to find specific information.

3. User Classes and Characteristics The major features of project are:

• User Authentication: The system will require user authentication to access the dashboard and data.
• Dashboard Display: The system will display real-time data retrieved from an external API in the form of an interactive dashboard.
• API Integration: The system will integrate with a third-party API to retrieve real-time data.
• Customizable Widgets: Users can customize the dashboard by adding, removing, or repositioning widgets.
• Data Retrieval: The system will send requests to the API to retrieve specific data and display it on the dashboard.
• Filtering and Searching: Users can filter and search the displayed data on the dashboard based on their preferences.
• Display Settings: Users can change the display settings for the dashboard, such as color scheme and font size.

4. Operating Environment The Dashboard developed to display information from an API will be a web application that will operate in a web browser environment. The system will be designed to work on any hardware platform that can run a modern web browser such as Google Chrome, Mozilla Firefox, or Microsoft Edge. The system will be developed using HTML, CSS, and JavaScript, and will be compatible with the latest versions of these technologies.

The application will not require any specific operating system as it will be run within the web browser. The system will not have any dependencies on any other software components or applications, but it will be designed to integrate seamlessly with the API from which it will retrieve data. The system will have a user-friendly interface that will be intuitive and easy to navigate, allowing users to interact with the application seamlessly.

5. Design and Implementation Constraints Design and implementation constraints for the project "Developing a Dashboard to Display Information from an API" may include:

• Technology stack: The software may need to be developed using specific programming languages, frameworks, and libraries. For example, if the API provides data in JSON format, the software may need to use a library that can parse JSON data.

• API documentation: The software development may depend on the documentation provided by the API vendor. Any changes in the API may require updating the software.

• Data Security: The software must ensure that the data received from the API is secure and confidential. Proper security measures must be implemented to protect user data.

• User Interface: The dashboard must have a clean, user-friendly interface that is easy to navigate. The user should be able to easily find and select the data they want to view.

• Compatibility: The software must be compatible with various web browsers and operating systems, such as Chrome, Firefox, Safari, Internet Explorer, Windows, and MacOS. Any incompatibilities must be identified and addressed during the development phase.

• Performance: The software must be able to handle a large amount of data and requests from multiple users simultaneously. It should be optimized for quick response times and minimal downtime.

6. User Documentation The following user documentation components will be delivered along with the software:

• User Manual: A comprehensive user manual will be provided in PDF format, explaining the functionalities and usage of the software.

• On-line Help: On-line help will be provided in the form of context-sensitive help within the software.

• Tutorials: Step-by-step tutorials will be provided to guide users on how to use specific features of the software.

All user documentation will be delivered in English, in accordance with industry-standard formats and standards.

7. Assumptions and Dependencies Assumptions:

• The API will be available and accessible through standard HTTP(S) requests.

• The API will provide data in a consistent format that can be easily parsed and displayed on the dashboard.

• The users have basic knowledge of how to use a web application and are familiar with the concept of APIs. Dependencies:

• The project depends on the availability and stability of the external API.

• The project may depend on third-party libraries or frameworks for implementation.

• The project may depend on the availability of certain hardware or software components, such as a web server or a specific operating system.

[DucHien0643]

Task3: System Features

1. System Feature 1 Description and Priority The feature will display real-time data retrieved from an external API in the form of an interactive dashboard. It is of high priority as it is the primary function of the software. Stimulus/Response Sequences

   • User logs in to the dashboard
   • User selects the desired information to display from the API
   • The system sends a request to the API to retrieve the data
   • The API sends the requested data to the system
   • The system displays the data on the dashboard in the form of customizable widgets Functional Requirements REQ-1: The system shall allow users to log in to the dashboard using a valid username and password. REQ-2: The system shall provide a user interface for users to select the desired information to display from the API. REQ-3: The system shall send a request to the API to retrieve the selected data. REQ-4: The system shall receive and process the data from the API in real-time. REQ-5: The system shall display the received data on the dashboard in the form of customizable widgets. REQ-6: The system shall allow users to customize the dashboard by adding, removing, or repositioning widgets. REQ-7: The system shall be able to handle errors or invalid inputs by displaying error messages or appropriate feedback to the user.

2. System Feature 2 (and so on)

[DucHien0643]

Task4: External Interface Requirements

1. User Interfaces The dashboard will have a web-based user interface that can be accessed via any modern web browser. The interface will be designed to be intuitive, user-friendly, and visually appealing, with a clean and modern design. It will include graphical representations of the data and will allow users to interact with the data by filtering, sorting, and exporting it.
2. Hardware Interfaces The software product will run on any standard hardware platform that supports modern web browsers
3. Software Interfaces The dashboard will receive data from an external API, which will be documented separately. The API will provide the data in a standardized format that can be easily consumed by the dashboard. The dashboard will also use various open-source libraries and frameworks, including React.js, D3.js, and Bootstrap, which will be documented separately.
4. Communications Interfaces The dashboard will communicate with the external API using standard HTTP/HTTPS protocols. No other communications interfaces are required.

[DucHien0643]

Task5: Other Nonfunctional Requirements

1. Performance Requirements The performance requirements for the product are as follows:

• The system should be able to handle a minimum of 1000 concurrent users without any degradation in performance.
• The response time for any user action should be less than 2 seconds under normal load conditions.
• The system should be able to handle a maximum of 5000 concurrent users during peak usage hours, with the response time remaining less than 5 seconds.
• The system should be available for use 99% of the time, excluding scheduled maintenance periods.
• These performance requirements are necessary to ensure that the system can handle the expected load and usage patterns.

2. Safety Requirements The safety requirements for the product are as follows:

• The system should not allow any actions that could result in harm to the users or to the environment.
• The system should include appropriate safeguards to prevent accidental or intentional misuse.
• The system should comply with all relevant safety regulations and certifications.
• These safety requirements are necessary to ensure that the product is safe for use and does not pose any risks to the users or the environment.

3. Security Requirements The security requirements for the product are as follows:

• User authentication should be required to access any sensitive or private data.
• The system should use encryption to protect any data in transit or at rest.
• The system should comply with all relevant security and privacy regulations and certifications.
• These security requirements are necessary to ensure that the product protects user data and complies with any legal or regulatory requirements.

4. Software Quality Attributes The software quality attributes for the product are as follows:

• Usability: The system should be easy to use and intuitive for all users.
• Maintainability: The system should be easy to maintain and update.
• Reliability: The system should be reliable and able to handle errors and failures gracefully.
• Performance: The system should perform well under normal and peak load conditions.
• Testability: The system should be easily testable to ensure that it meets all requirements.
• These software quality attributes are necessary to ensure that the product is of high quality and meets the needs of the users and developers.

[DucHien0643]

Task6: Other Requirements There are no other requirements at this time. Appendix A: Glossary

• SRS: Software Requirements Specification
• API: Application Programming Interface
• UI: User Interface
• SQL: Structured Query Language
• SSL: Secure Sockets Layer
• HTTP: Hypertext Transfer Protocol Appendix B: Analysis Models There are no analysis models at this time. Appendix C: Issues List There are no outstanding issues at this time.

[DucHien0643]

Task7: Tổng hợp các nội dung trên vào file doc Link: https://docs.google.com/document/d/1dALNLEohY3rljHvNFlph05tQ5CVzHeewnsYsG2REb8s/edit?usp=sharing