TechnicalManual-Template-V3
.docx
School
University of Wollongong**We aren't endorsed by this school
Course
CSCI 991
Subject
Computer Science
Date
Jan 15, 2025
Pages
6
Uploaded by UltraManateePerson768
School of Computer Science & Software EngineeringBachelor of Computer ScienceBachelor of Information TechnologyCSCI321- ProjectTechnical Manual[Date]Group: [Group Number]Student Name 1Student Num 1Email 1Student Name 2Student Num 2Email 2Student Name 3Student Num 3Email 3Student Name 4Student Num 3Email 4Student Name 5Student Num 4Email 5Supervisor: [Supervisor’s name]Assessor: [Assessor’s name]
Technical Manual[Group Number]Page 2of 6Document ControlTitle:Project DocumentDocument Name:Filename of your documentOwnerCurrent VersionLast Change onApproved byDateTimeDistribution ListNameTitle/RoleWhere (the location the document is stored)Record of RevisionRevision DateDescriptionSection AffectedChanges Made byVersion after Revision
Technical Manual[Group Number]Page 3of 6Table of ContentsDocument Control............................................................................................................................2Introduction......................................................................................................................................4Project Backgound............................................................................................................................4Project Scope....................................................................................................................................4Stakeholder......................................................................................................................................4Project Team.....................................................................................................................................4Project Website................................................................................................................................4Development Methodology..............................................................................................................5Risk List.............................................................................................................................................5Test Plan...........................................................................................................................................5Requirement Specification................................................................................................................5Design Specification..........................................................................................................................5Appendix..........................................................................................................................................6
Technical Manual[Group Number]Page 4of 6Introduction[This section should describe the need for this documentation. It should briefly describe its contexts and purposes and explain how it is organized and used. States the context of what a technical manual is and what you would include in this document. State your objective; make it clear how you would use this document to manage and monitor your project, and finally preview the contents of your Technical Manual; that is, how you organize your Technical Manual.] Project Background[This sub-section should provide the general background information about the project. The researches done on the topics related to the project and identified issues that need to be addressed and the problem needs to be solved. This should set the scene for the work that follows including ideation steps and a brief summary of your group and process.]Project Scope[This sub-section should describe the scope of the project. It should clearly specify the boundary of the project. From the background information you have obtained, you should pretty much know which areas are to be done in the project and which are not? What are the technologies that you will be using and how you would like the project to be done or implemented?]Stakeholder[This sub-section should identify the people who have either direct or indirect involvement (have interest) in the project. For example, who are the developers? Who are the project assessor and/or supervisors? Etc.]Project Team[This section provides the profile of the project team members.]Project Website[This section provides the description of the Project Website setup for the project. It should describe the objectives and the structure of the website. Provide the URL of your website here.]
Technical Manual[Group Number]Page 5of 6Development Methodology[This section should describe the development methodology used for the project, including the project management, deliverables as well as quality assurance aspects. This could include some visual evidence of milestones and process, such as Gantt charts and any evidence of planning and iteration. It should be clear to the reader how and why you have settled on certain approaches for your project and how resources and time are allocated in relation to the functionality of your system. There should be a detailed breakdown of your plan in terms of a working process and set of expectations for deliverables (e.g., dates, times, functionality, etc.)]Risk List[This section should contain the identified risks list of the project.]Test Plan[This section describes the test plan and test strategies the team decided to use throughout the system (projecvelopment) det process.]Requirement Specification[This section describes the services (functional requirements) provided for the user as well as the non-functional system requirements. The description may be in natural language, diagrams or other notations that are understandable by stakeholders (Stakeholders are all parties directly or indirectly related or involve in your projects. E.g., Programme Director, Project Supervisor, Assessor, Project team members, etc.) UML Tools such as use-case diagram and use-case description may be used for the specification of all the requirements (Functional, Non-functional, and other requirements.) Functional requirements are the functionalities of the system, which are the services the system (your product) should provide.Non-functional requirements are requirements that are not directly concerned with the specific functions delivered by the system. Examples of non-functional requirements are the operational requirements (how the system is operated), performance requirements, interface requirements, safety requirements, security requirements, portability requirements, authorization requirement, etc.]
Technical Manual[Group Number]Page 6of 6Design Specification[This section provides the description of the structure of the application to be implemented, the data which is part of the system, the interfaces between system components and the algorithms used. The description may be in natural language, diagrams or models that are understood by the developers. You should focus on how you have come about your design specifications through prototyping and evaluation. You should validate and verify with your requirement specification with a clear view about what it is you are building and the approaches that you intend to take. It should be clear what you are intending to build and how you intend to go about producing such a build in the time frame given. You may sub-divide this section into Systems Architecture, Detail Components / Modules Design, Conceptual Schema (if any), and User Interface.Architecture Design is the description and definition of the sub-systems making up the system and their relationships as well as the technologies. It specifies the services of the system and the constraints under which the components must operate.Process-Flow, Data-Flow, State and Transition of all components are described here. UML Tools such as Sequence Diagram, Interaction Diagram, Communication Diagram, State Diagram, Transition Diagram, Activity Diagram, etc, may be used to describe and define each of the components.Semantic Data Model is representational model that describe the logical form of the data processed by the system. It identifies the various entities and their relationship in the system. Semantic Data Model can be represented using Entity Relationship Diagram (ERD) or Unified Modeling Language (UML).Interface design is the description of the interfaces among the sub-systems and other external systems. The interface design specification must be unambiguous as it allows the sub-system to be used without knowledge of the sub-systems operation.]Appendix[This section contains all appendices that you have references somewhere in the body of your proposal. This may include supporting material such as hardware and software description, templates, etc.]