DESC:FIELD OF THE INVENTION
The present embodiment relates to a method of inputting software details in a Software Requirements Specification (SRS) document, and more particularly relates to the method of automatically generating SRS document.
BACKGROUND OF THE INVENTION
A Software Requirements Specification (SRS) document is a document that captures the understanding of the desired software features in a standard format. The A SRS document is mandatory by a majority of service providers. The SRS document ensures that service provider has properly understood the requirements and needs of the client. The SRS formats have been standardized by international standard agencies such as IEEE and ISO.
Presently, the SRS document is manually filled by a SRS documentation expertise and this may usually take around 7-10 days based on the complexity of the software project. The manual process includes a variety of disadvantages vis-à-vis a higher consultant cost, increased risk of manual errors, requirement of SRS documentation expertise and longer time duration.
Therefore, there is a need of a method that can automatically generate the SRS document, there avoiding manual errors. There is also a need of the method that can reduce the time duration for the SRS document generation.
OBJECTIVES OF THE INVENTION
An objective of the present embodiment is to provide an end-to-end method for comprehensive automation of SRS document generation.
Another objective of the present embodiment is to provide a cost-effective method for SRS document generation.
Yet another objective of the present embodiment is to provide robust software with an order of magnitude higher in the level of automation.
SUMMARY OF THE INVENTION
In an aspect, a computer-implemented method for automatic Software Requirements Specification (SRS) document generation is provided. The computer-implemented method includes the following steps: 1) Categorizing client requirements into a plurality of feature groups. 2) Converting the plurality of feature groups into Normalized Domain Elements (NDE) or Fundamental Software Constructs (FSC). 3) Capturing the Normalized Domain Elements (NDE) or Fundamental Software Constructs (FSC) into a standard format. 4) Marking IEEE Std 830-1993 document with placeholders for various software elements for the generation of SRS document.
The preceding is a simplified summary to provide an understanding of some aspects of embodiments of the present invention. This summary is neither an extensive nor exhaustive overview of the present invention and its various embodiments. The summary presents selected concepts of the embodiments of the present invention in a simplified form as an introduction to the more detailed description presented below. As will be appreciated, other embodiments of the present invention are possible utilizing, alone or in combination, one or more of the features set forth above or described in detail below.
BRIEF DESCRIPTION OF THE DRAWINGS
Figure 1 illustrates a computer-implemented method for automatic Software Requirements Specification (SRS) document generation, according to an embodiment herein.
To facilitate understanding, like reference numerals have been used, where possible, to designate like elements common to the figures.
DETAILED DESCRIPTION
As used throughout this application, the word "may" is used in a permissive sense (i.e., meaning having the potential to), rather than the mandatory sense (i.e., meaning must). Similarly, the words “include”, “including”, and “includes” mean including but not limited to.
The phrases “at least one”, “one or more”, and “and/or” are open-ended expressions that are both conjunctive and disjunctive in operation. For example, each of the expressions “at least one of A, B and C”, “at least one of A, B, or C”, “one or more of A, B, and C”, “one or more of A, B, or C” and “A, B, and/or C” means A alone, B alone, C alone, A and B together, A and C together, B and C together, or A, B and C together.
The term “a” or “an” entity refers to one or more of that entity. As such, the terms “a” (or “an”), “one or more” and “at least one” can be used interchangeably herein. It is also to be noted that the terms “comprising”, “including”, and “having” can be used interchangeably.
As previously mentioned, there is a need of a computer-implemented method that can automatically generate a Software Requirements Specification (SRS) document. The SRS document includes functional features, performance features, system configuration, design & architecture, operating environment for the software, constraints & risks, assumptions & dependencies, external interfaces and safety, security and quality.
The computer-implemented method includes a server for hosting a UI infrastructure on a device such as server, laptop and computer. The computer-implemented method for automatically generating the SRS document includes the following steps:
At step 102, Client requirements are categorized into a plurality of feature groups or domain design terms. In an embodiment, the client requirements are listed in a Statement Of Work (SOW) document. The requirements are categorized into the plurality of feature groups through an artificial intelligence based Natural Language Processing (NLP) method. The plurality of feature groups is mentioned in Table 1.
FEATURE CATEGORIZATION
1. Basic Features - Add, Edit, Delete, Import, Export, Print, View
2. Workflow Features - Dynamic process features
3. Performance Features - Within 2 seconds app response, scalability to 10k concurrent connections, etc
4. Optimization Features - Adaptive features e.g. on handheld, mobile, 128kbps network, etc
5. Integration Features - Database to be Oracle, Integration with SAP, Gmail
6. Information Features - Reports, Dashboards, Website (help/public info access)
7. Privileges Features - Roles, Authority, Access Control, etc
8. Security Features - Encryption, Password protection, etc
9. Business Continuity Features - Backup, Archival, Data Storage for 5 years, etc
10. UI Features - Look, Color, Feel, Responsiveness
11. Infrastructure - Servers, PCs, etc Hardware to be provided along with the application
12. Safety Requirements
13. Security Requirements
14. Software Quality Attributes
15. Business Rules
Table 1
At step 104, the plurality of feature groups or domain design terms is converted into Normalized Domain Elements (NDE) or Fundamental Software Constructs (FSC). The fundamental elements or software constructs are mentioned in Table 2.
NORMALIZED DOMAIN ELEMENTS & FUNDAMENTAL SOFTWARE CONSTRUCTS
NORMALIZED DOMAIN ELEMENTS
1. Attribute
2. Value Object
3. Entity
4. Aggregate
5. Relationship
6. Process
7. Event
8. Payload
9. Rule
10. Condition
11. Task
12. Input
13. Action
14. Output
FUNDAMENTAL SOFTWARE CONSTRUCTS
15. API
16. Report
17. Form
18. Dashboard
19. Website
20. Role
21. Role-Process-Map
Table 2
At step 106, the normalized domain elements (NDE) or fundamental software constructs (FSC) are captured in a standard format such as JSON/XML. Further, features, configurations, architecture, environment, & interfaces based on the JSON/XML are already documented.
At step 108, template document such as, but not limited to, IEEE Std 830-1993 is marked with placeholders for various software elements and the data from the JSON format is then filled in the appropriate points and sections to generate the feature list as listed in the SRS contents. The functional features, performance features, system configuration, design & architecture, operating environment for the software, constraints & risks, assumptions & dependencies, external interfaces and safety, security and quality are automatically documented in the SRS document.
SNO CATEGORY SUBCATEGORY NDE-FSC MAP
1.1 Revision No Revision No NDE-FSC JSON revision
1.2 Revision History Past SRS auto-generated for the Project
2 Introduction Purpose SRS for
2.1 Document Conventions Standard
2.2 Intended Audience and Reading Suggestions Standard
2.3 Product Scope NDE-FSC scope
2.4 References Standard
3 Overall Description Product Perspective About PRODUCT (including FORM & FLOW)
3.1 Product Functions PRODUCT features (Basic, Workflow, Integration, Customization)
3.2 User Classes and Characteristics UAM Configurator (Roles & Privileges)
3.3 Operating Environment Product Configuration
3.4 Design and Implementation Constraints Standard
3.5 User Documentation Standard
3.6 Assumptions and Dependencies Standard
4 External Interface Requirements
User Interfaces UI Configurators (including defaults, Custom form Configurator, Reports, Dashboard, Website)
4.1 Hardware Interfaces PRODUCT configurator
4.2 Software Interfaces Internal API endpoints
4.3 Communications Interfaces External API configurator
5 System Features System Feature 1 Process 1
5.1 System Feature 2 (and so on) Process 2 (and so on)
6 Nonfunctional Requirements Performance Requirements Performance requirements from AI feature category and performance features inbuilt in PRODUCT
6.1 Safety Requirements Safety requirements from AI feature category and safety features inbuilt in PRODUCT
6.2 Security Requirements Security requirements from AI feature category and security features inbuilt in PRODUCT
6.3 Software Quality Attributes Software Quality requirements from AI feature category and Software Quality features inbuilt in PRODUCT
6.4 Business Rules Rules by Process
7 Other Requirements Other requirements from AI feature category
8 Appendix A: Glossary Standard
9 Appendix B: Analysis Models Standard
10 Appendix C: To Be Determined List Standard


Table 3: NDE-FSC to IEEE SRS Std 830-1993 MAP
The present method is highly automated method for the SRS document generation.
The foregoing discussion of the present invention has been presented for purposes of illustration and description. It is not intended to limit the present invention to the form or forms disclosed herein. In the foregoing Detailed Description, for example, various features of the present invention are grouped together in one or more embodiments, configurations, or aspects for the purpose of streamlining the disclosure. The features of the embodiments, configurations, or aspects may be combined in alternate embodiments, configurations, or aspects other than those discussed above. This method of disclosure is not to be interpreted as reflecting an intention the present invention requires more features than are expressly recited in each claim. Rather, as the following claims reflect, inventive aspects lie in less than all features of a single foregoing disclosed embodiment, configuration, or aspect. Thus, the following claims are hereby incorporated into this Detailed Description, with each claim standing on its own as a separate embodiment of the present invention.
Moreover, though the description of the present invention has included description of one or more embodiments, configurations, or aspects and certain variations and modifications, other variations, combinations, and modifications are within the scope of the present invention, e.g., as may be within the skill and knowledge of those in the art, after understanding the present disclosure. It is intended to obtain rights which include alternative embodiments, configurations, or aspects to the extent permitted, including alternate, interchangeable and/or equivalent structures, functions, ranges or steps to those claimed, whether or not such alternate, interchangeable and/or equivalent structures, functions, ranges or steps are disclosed herein, and without intending to publicly dedicate any patentable subject matter.
,CLAIMS:WE CLAIM:
1. A computer-implemented method (100) for automatic Software Requirements Specification (SRS) document generation, the method comprises:
- categorizing client requirements into a plurality of feature groups, wherein the client requirements are listed in a Statement Of Work (SOW) document;
- converting the plurality of feature groups into Normalized Domain Elements (NDE) or Fundamental Software Constructs (FSC);
- capturing the Normalized Domain Elements (NDE) or Fundamental Software Constructs (FSC) into a standard format, wherein the standard format is JSON/XML; and
- marking IEEE Std 830-1993 document with placeholders for various software elements for the generation of SRS document.
2. The computer-implemented method (100) as claimed in claim 1, wherein the requirements are categorized into the plurality of feature groups through an artificial intelligence based Natural Language Processing (NLP) method.
3. The computer-implemented method (100) as claimed in claim 1, wherein the plurality of feature groups include basic features, workflow features, performance features, optimization features, integration features, information features, privileges features, security features and UI features.
4. The computer-implemented method (100) as claimed in claim 1, wherein the NDE includes attribute, value object, entity, aggregate, relationship, process, event, payload, rule, condition, task, input, action and output.
5. The computer-implemented method (100) as claimed in claim 1, wherein the FSC includes API, reports, form, dashboard, website, role and role-process-map.
6. The computer-implemented method (100) as claimed in claim 1, wherein the data from the JSON format is filled in IEEE Std 830-1993 document to generate the feature list.