This article is written by the Ruiyicuan Soft Work Group. Please contact the group in advance to use or reprint all or part of the documents. Thank you.
Project Documentation: Outline Design Documentation
1. Introduction
The introduction part mainly explains the purpose of writing, the scope of the system and reference materials.
1.1 Purpose
The purpose of this document is to describe the outline design of the software for students' rubbing courses. The main contents include the introduction of system functions, system structure design, module design and interface design.
The intended audience of this document includes: designers, developers, project managers, testers.
1.2 Scope
1.2.1 System goals
Develop an Android app that meets the needs of college students to take classes in their spare time. It can not only allow everyone to check the relevant information of the courses they are interested in, but also meet the needs of students to jump to the website of the Academic Affairs Office on the bulletin board to receive timely notifications, and also provide a community section to view other people's discussions, messages, and related courses. 's review.
1.2.2 Main software requirements
The main functions of the system include:
l System initialization settings
l User management
l Search related courses
l Community discussion
l Bulletin board service (jump to the educational administration system and Baidu and other websites)
l Personal page
1.2.3 Software Design Constraints and Limitations
The software supports a distributed physical structure used by multiple clients at the same time.
1.3 Abbreviations
without.
1.4 Definition of terms
without.
1.5 References
[1] Dou Wanfeng. Software Engineering and Practice [M]. Beijing: Machinery Industry Press, 2017.
[2] Annotation of software outline design document format [S].GB 856D-1988.
1.6 version information
The specific version information is shown in Table A-1.
Table A-1 Specific version information
| Modification number |
Modified date |
Modified version |
Modify location |
Overview of Modifications |
| 1 |
2018-5-1 |
1.0 |
all |
Complete the first write |
|
|
|
|
|
|
2. Data Design
This part mainly describes the structure description of the external data involved in the software. If the data is presented in a database file, describe the name of the table and table field structure; if the data is presented in an external file, describe the internal structure of the file.
2.1 Data Objects and Formed Data Structures
The main data structure designed by the "Chuang Yi Chuang" app is as follows:
Course Schedule: Course number, course name, course type, college to which the course belongs, course teacher, course time, course credits, course starting semester, and the name of the textbook used in the course.
Community table: User ID, User Nickname, Blog ID, Blog Name, and Date of Posting the Blog.
Personal Information Table: User ID, User Nickname, User Password, Preferred Course Number, Preferred Course Name, Preferred Course Type, Preferred Course School, Preferred Course Teacher, Course Time, Preferred Course Credits, Preferred Course Semester, and Course Books name.
User summary table: user name, user password, mobile phone number for user registration, whether the user is bound to the mailbox number, user mailbox number, user creation date, user update date.
2.2 File and database structure
Describes the database structure of the file.
2.2.1 External file structure
Including the logical structure of the file, the description of the logical record, and the access method.
2.2.2 Global data
The global variables of the "Swipe" app are:
System Clock Timer
2.2.3 Document and data cross-reference
l The user information file is in the user management and user personal information (ie "my") functions;
l The curriculum file is used in the course search function;
l The community table file is used in the community function;
l The personal information table file is used in the personal information module to record the search preference function.
3 Architecture Design
This part mainly describes the logical composition interface of the software, that is, the drawing of the software structure diagram. However, the group used an object-oriented design approach, so the data flow diagram was replaced here with an activity diagram.
3.1 Data and Control Flow Review
Summarize and analyze the functions to be implemented in the requirements specification, summarize and merge the involved data and control flow, and prepare for the outline design.
Generally, the refined analysis of the data flow diagram includes two aspects. One is to review the entire data flow diagram to see if there are any omissions, and to supplement and improve it. The second is to analyze each data flow diagram (activity diagram), and remove some details. Here, data storage and external users are removed.
The refined scenarios of some data flow diagrams (activity diagrams) are described as follows:
To be added.
3.2 The resulting program structure
According to the reviewed data flow diagram (activity diagram), the logical structure of the software is gradually obtained. Using the optimization idea, the software structure diagram is optimized and designed, and the software structure diagram with moderate module hierarchy is obtained. As follows:
4. Interface Design
This part mainly gives the general requirements and interface sequence of interface design, as well as interface design conventions.
4.1 HMI Protocol
Give the interface style, convention and operation requirements, and design all user interfaces. The interface of the mobile phone APP mainly includes the following types.
(1) The first login interface: This interface can enter the user name and SMS verification code; the user name is the user's legal mobile phone number, and then log in by obtaining the verification code. At the same time, the login interface also has a user registration function.
(2) Curriculum Query Interface: This interface is mainly used to search through the search method selected by the user, and finally display the results; the search methods should be divided into search by class time, teacher search, and course name search. The final displayed result should include course name, course number, course type, starting college, teaching teacher, class time, class location, credits, semester. At the same time, users can bookmark their favorite courses.
(3) Bulletin board interface: This interface is mainly for users to view news and announcements in a timely manner through the links provided by the Academic Affairs Office and Baidu; there should be two links in this interface, and users can realize the jump function when selecting a link . It is convenient for users to read the information.
(4) Community interface: This interface mainly displays the speech records of all users. It will be continuously refreshed through the drop-down interface, and it should also provide the function of speaking by itself.
(5) Personal information interface: This interface is mainly used to set personal information and display preferred course information; the set personal information should include nickname, department, and avatar. The department should be one of the fourteen departments of Huazhong Agricultural University. After the setting is completed, save it. The displayed preferred course information should include: preferred course semester, preferred course name, preferred course number, preferred course credits, preferred course Course type, preferred college, preferred course teacher name, preferred course class location, preferred course class time, and textbook name.
(6) Master control interface: It is the main interface of the software, which mainly completes the interaction tasks with users, receives user requests, and calls corresponding modules.
4.2 Human-machine interface design specification
Give the interface sequence relationship, as well as the operation rules and processing rules of each interface. There are the following interface sequences for the "Chu Yi Chuang" mobile APP.
Login first interface:
Interface sequence for new users: Registration—Enter the master control interface (search interface).
Interface sequence for old users: login - enter the master control interface (search interface).
Sequence of master control interface and rubbing course query interface: master control interface - search according to the selected method - get the search results.
Sequence of master control interface and bulletin board interface: master control interface - bulletin board interface - click the link to jump.
Sequence of master control interface and community interface: master control interface—community interface—choose to speak or browse—refresh the interface.
Master control interface and personal information interface sequence: master control interface—personal information sequence—select to set personal information or view preferred courses—save or display the results.
5 Interface Design
This section mainly describes the interface types and parameters of the module.
Update after coding is confirmed
6 Module Process Design
6.1 Check the Course Subsystem
1. External users
User: The legitimate user of the system.
2. Function
View courses by course title;
Check the course through the teacher in the class;
View courses by class time.
3. Use Case Model View
4. Activity diagram
5. Scenario description
Use Case Name: Look up courses by course name.
Scope: Consult the Curriculum Subsystem.
Level: Important.
Main actors: users (concerned about the legitimacy of identities).
Stakeholders and their concerns: None.
Precondition: Legal user.
Guaranteed success: Enter the app.
Main Success Scenario:
(1) Select the View Courses by Course Name button.
(2) Enter the course name.
(3) Get the results of the courses reviewed.
Extension:
(2a) The button to find courses by other criteria is selected
Special needs: none.
Technology and Data Change Elements: Using Database Management.
Frequency of occurrence: often
Use case name: Check the course through the class teacher.
Scope: Consult the Curriculum Subsystem.
Level: Important.
Main actors: users (concerned about the legitimacy of identities).
Stakeholders and their concerns: None.
Precondition: Legal user.
Guaranteed success: Enter the app.
Main Success Scenario:
(1) Select the button to view the course according to the class teacher.
(2) Enter the course name.
(3) Get the results of the courses reviewed.
Extension:
(2a) The button to find courses by other criteria is selected
Special needs: none.
Technology and Data Change Elements: Using Database Management.
Frequency of occurrence: often
Use case name: Viewing courses by class time.
Scope: Consult the Curriculum Subsystem.
Level: Important.
Main actors: users (concerned about the legitimacy of identities).
Stakeholders and their concerns: None.
Precondition: Legal user.
Guaranteed success: Enter the app.
Main Success Scenario:
(1) Select the button to view courses by class time.
(2) Enter the course name.
(3) Get the results of the courses reviewed.
Extension:
(2a) The button to find courses by other criteria is selected
Special needs: none.
Technology and Data Change Elements: Using Database Management.
Frequency of occurrence: often
6.2 Bulletin Board Subsystem
1. External users
User: The legitimate user of the system.
2. Function
Jump to the website of the Office of Academic Affairs;
Jump to Baidu website.
3. Use Case Model View
4. Activity diagram
5. Scenario description
Use case name: Jump to the website of the Academic Affairs Office.
Scope: Bulletin board subsystem.
Level: Important.
Main actors: users (concerns about identity legitimacy).
Stakeholders and their concerns: None.
Precondition: Legal user.
Success Guaranteed: Enter the app and connect to the Internet.
Main Success Scenario:
(1) Select the Jump to Academic Affairs Office website button.
(2) Jump to the website of the Academic Affairs Office (still inside the app).
Extension:
(2a) The button to jump to other websites is selected
Special requirements: none.
Technology and Data Change Elements:
Frequency of occurrence: often
Use case name: Jump to Baidu website.
Scope: Bulletin board subsystem.
Level: Important.
Main actors: users (concerns about identity legitimacy).
Stakeholders and their concerns: None.
Precondition: Legal user.
Success Guaranteed: Enter the app and connect to the Internet.
Main Success Scenario:
1) Select the Jump to Baidu website button.
2) Jump to Baidu website (still inside the app).
6.3 Community Subsystem
1. External users
User: The legitimate user of the system.
2. Function
user speech;
User evaluation of rubbing lessons;
User-recommended courses;
Users view what other users are saying.
3. Use Case Model View
4. Activity diagram
5. Scenario description
Use Case Name: Speak.
Scope: Community submodule.
Level: Important.
Main actors: users.
Stakeholders and their concerns: Users care about how to speak.
Precondition: Legal user.
Success Guarantee: The login is successful.
Main Success Scenario:
(1) Enter the content you want to speak in the text box.
(2) Click the Speak button to request to speak.
(3) Send a request to speak.
(4) The system agrees to the request to speak.
(5) The system accepts the speech text and displays it on the interface.
expand:
(5a) If the input content is blank, the speech fails.
Special needs: none
Technology and data change elements: The user's speech content can be stored in files or stored and managed in a database.
Frequency of occurrence: Often.
Use case name: Evaluate rubbing classes.
Scope: Community submodule.
Level: Important.
Main actors: users.
Stakeholders and their concerns: Users are concerned about how to evaluate rubbing courses.
Precondition: Legal user.
Success Guarantee: The login is successful.
Main Success Scenario:
(1) Enter the content you want to evaluate in the text box.
(2) Click the Speak button to request an evaluation of the class.
(3) Send a request for evaluation of the class.
(4) The system agrees to the request for evaluation of rubbing lessons.
(5) The system accepts the evaluation text and displays it on the interface.
expand:
(5a) If the input content is blank, the evaluation of the rubbing lesson fails.
Special needs: none
Technology and data change elements: The content of user evaluations and lessons can be stored in files or stored and managed in databases.
Frequency of occurrence: Often.
Use Case Name: Recommended Course.
Scope: Community submodule.
Level: Important.
Main actors: users.
Stakeholders and their concerns: Users focus on how to recommend courses.
Precondition: Legal user.
Success Guarantee: The login is successful.
Main Success Scenario:
(1) Enter the content of the course you want to recommend in the text box.
(2) Click the Speak button to request a recommended course.
(3) Send a recommended course request.
(4) The system agrees to the recommended course request.
(5) The system accepts the recommended course text and displays it on the interface.
expand:
(5a) The input content is blank and the recommended course fails.
Special needs: none
Technology and data change elements: The user's recommended course content can be stored in files or stored and managed in a database.
Frequency of occurrence: Often.
Use Case Name: View.
Scope: Community submodule.
Level: Important.
Main actors: users.
Stakeholders and their concerns: Users care about how to see.
Precondition: Legal user.
Success Guarantee: The login is successful.
Main Success Scenario:
(1) Click on the community section.
(2) Enter the community section.
(3) View the content of speeches, evaluations, and recommended courses on this page.
(4) Click the next page to view the content of speeches, evaluations, and recommended courses on the next page.
expand:
(5a) There is no speech content, and the viewing fails.
Special needs: none
Technology and data change elements: The content of user evaluations and lessons can be stored in files or stored and managed in databases.
Frequency of occurrence: Often.
6.4 My Subsystem
1. External users
User: The legitimate user of the system.
2. Function
Set personal information (set nickname, etc.);
View preferred courses.
3. Use Case Model View
4. Activity diagram
5. Scenario description
Use case name: set personal information (set nickname)
Scope: "mine" subsystem.
Level: Important.
Main actors: users (concerned about the legitimacy of identities).
Stakeholders and their concerns: None.
Precondition: Legal user.
Guaranteed success: Enter the app.
Main Success Scenario:
(1) Select the Set Personal Information button.
(2) Enter a nickname.
(3) Save the modified information.
Extension:
(2a) Enter an illegal character space and click Refill;
Special needs: none.
Technology and Data Change Elements: Using Database Management.
Frequency of occurrence: often
Use Case Name: View Preferred Courses
Scope: "mine" subsystem.
Level: Important.
Main actors: users (concerned about the legitimacy of identities).
Stakeholders and their concerns: None.
Precondition: Legal user.
Guaranteed success: Enter the app.
Main Success Scenario:
(1) Select the My Preferred Courses button.
(2) Obtain relevant information about preferred courses.
Extension:
without
Special needs: none.
Technology and Data Change Elements: Using Database Management.
Frequency of occurrence: often
7. Requirement cross-reference
Describe the relationship between requirements and modules, there is an intersection part, that is, the calling relationship of shared modules.
l User management: login, registration
l Search related courses: search by class time, teacher search, and course name search.
l Community discussion: save recorded speeches and browse other speeches.
l Bulletin board service: jump to the educational administration system and Baidu and other websites
l Personal page: Set personal information (nickname, department) and view preferred course information.
This article is written by the Ruiyicuan Soft Work Group. Please contact the group in advance to use or reprint all or part of the documents. Thank you.