Update README.md

This commit is contained in:
Thinkwee 2024-10-08 15:18:08 +08:00 committed by GitHub
parent 7d3d8f68b7
commit 46370307f9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -13,6 +13,19 @@ Welcome to SRDD (Software Requirement Description Dataset), a large prompted dat
- Category of this software
- Details
- check.csv # Check Results
- The check csv file contains 14 columns, which are:
- SoftwareCategory
- SoftwareName
- SoftwareDescription
- Whether Obey Rule 1/2/3/4/5
- Reason For Obeying(or not Obeying) Rule 1/2/3/4/5
- Count of Rules Obeyed
- The 5 rules are designed to make sure the generated software descriptions are clear to follow and easy to evaluate. Specifically, the 5 rules are:
- Describe the primary function of this software, emphasizing its simplicity, commonality, and feasibility in implementation.
- Craft a clear and comprehensive description that encapsulates all the essential information required to define the software's fundamental functionality.
- Specify that the software does not require internet access, highlighting its self-contained nature.
- This software can be realized without relying on real-world data sources.
- Highlight the software's user-friendliness, emphasizing that it can be operated by a single individual and does not necessitate multiple users for testing, in contrast to online chat software.
- data_ChatDev_format.sh # Data, in the format of executable shell scripts (in ChatDev)
- data_attribute_format.csv # Data, in the format of csv, containing three columns, Name/Description/Category
## Category