| Assessment Details | |||||
| Qualification Code/Title | ICT50220 Diploma of Information Technology | ||||
| Assessment Type | Assessment -02(Project) | Time allowed | |||
| Due Date | Location | AHIC | Term / Year | ||
| Unit of Competency | |
| National Code/Title | ICTICT435 Create technical documentation |
| Student Details | |||
| Student Name | Student ID |
| Student Declaration: I declare that the work submitted is my own, and has not been copied or plagiarized from any person or source. | Signature: ____________________________ Date: _____/______/__________ |
| Assessor Details | ||
| Assessor’s Name | ||
| RESULTS (Please Circle) | SATISFACTORY | NOT SATISFACTORY |
| Feedback to student: |
| Student Declaration: I declare that I have been assessed in this unit, and I have been advised of my result. I am also aware of my appeal rights. | Assessor Declaration: I declare that I have conducted a fair, valid, reliable and flexible assessment with this student, and I have provided appropriate feedback. | ||
| Signature | Signature | ||
| Date | Date |
| Instructions to the Candidates This assessment is to be completed according to the instructions given below in this document.Should you not answer the tasks correctly, you will be given feedback on the results and gaps in knowledge. You will be entitled to one (1) resubmit in showing your competence with this unit.If you are not sure about any aspect of this assessment, please ask for clarification from your assessor. Please refer to the College re-submission and re-sit policy for more information. If you have questions and other concerns that may affect your performance in the Assessment, please inform the assessor immediately.Please read the Tasks carefully then complete all Tasks.To be deemed competent for this unit you must achieve a satisfactory result with tasks of this Assessment along with a satisfactory result for another Assessment.This is an Open book assessment which you will do in your own time but complete in the time designated by your assessor. Remember, that it must be your own work and if you use other sources then you must reference these appropriately.Resources required completing the assessment tasks are Learner guide, PowerPoint presentation, Unit Assessment Pack (UAP), Access to other learning materials such as textbooks, Access to a computer, the Internet and word-processing system such as MS Word.Submitted document must follow the given criteria. Font must be Times New Roman, Font size need to be 12 and line spacing has to be Single line.Once you have completed the assessment, please upload the softcopy of the Assessment into AHIC Moodle.Plagiarism is copying someone else’s work and submitting it as your own. Any Plagiarism will result in a mark of Zero. |
Reasonable Adjustments
- Students with carer responsibilities, cultural or religious obligations, English as an additional language, disabilityetc. can request for reasonable adjustments.
- Please note, academic standards of the unit/course will not be lowered to accommodate the needs of any student, but there is a requirement to be flexible about the way in which it is delivered or assessed.
- The Disability Standards for Education requires institutions to take reasonable steps to enable the student with a disability to participate in education on the same basis as a student without a disability.
- Trainer/Assessor must complete the section below “Reasonable Adjustment Strategies Matrix” to ensure the explanation and correct strategy have been recorded and implemented if applicable.
- Trainer/Assessor must notify the administration/compliance and quality assurance department for any reasonable adjustments made.
- All evidence and supplementary documentation must be submitted with the assessment pack to the administration/compliance and quality assurance department.
| Reasonable Adjustment Strategies Matrix (Trainer/Assessor to complete) | ||
| Category | Possible Issue | Reasonable Adjustment Strategy (select as applicable) |
| ¨ LLN | ¨ Speaking ¨ Reading ¨ Writing ¨ Confidence | ¨ Verbal assessment ¨ Presentations ¨ Demonstration of a skill ¨ Use of diagrams ¨ Use of supporting documents such as wordlists |
| ¨Non-English-Speaking Background | ¨ Speaking ¨ Reading ¨ Writing ¨Cultural background ¨ Confidence | ¨ Discuss with the student and supervisor (if applicable) whether language, literacy and numeracy are likely to impact on the assessment process ¨ Use methods that do not require a higher level of language or literacy than is required to perform the job role ¨ Use short sentences that do not contain large amounts of information ¨ Clarify information by rephrasing, confirm understanding ¨ Read any printed information to the student ¨ Use graphics, pictures and colour coding instead of, or to support, text ¨ Offer to write down, or have someone else write, oral responses given by the student ¨ Ensure that the time available to complete the assessment, while meeting enterprise requirements, takes account of the student’s needs |
| ¨ Indigenous | ¨ Knowledge and understanding ¨ Flexibility ¨ Services ¨ Inappropriate training and assessment | ¨ Culturally appropriate training ¨ Explore understanding of concepts and practical application through oral assessment ¨ Flexible delivery ¨ Using group rather than individual assessments ¨ Assessment through completion of practical tasks in the field after demonstration of skills and knowledge. |
| ¨ Age | ¨ Educational background ¨ Limited study skills | ¨ Make sure font size is not too small ¨ Trainer/Assessor should refer to the student’s experience ¨ Ensure that the time available to complete the assessment takes account of the student’s needs ¨ Provision of information or course materials in accessible format. ¨ Changes in teaching practices, e.g. wearing an FM microphone to enable a student to hear lectures ¨ Supply of specialized equipment or services, e.g. a note-taker for a student who cannot write ¨ Changes in lecture schedules and arrangements, e.g. relocating classes to an accessible venue ¨ Changes to course design, e.g. substituting an assessment task ¨ Modifications to physical environment, e.g. installing lever taps, building ramps, installing a lift |
| ¨Educational background | ¨ Reading ¨ Writing ¨ Numeracy ¨ Limited study skills and/or learning strategies | ¨ Discuss with the Student previous learning experience ¨ Ensure learning and assessment methods meet the student’s individual need |
| ¨ Disability | ¨ Speaking ¨ Reading ¨ Writing ¨ Numeracy ¨ Limited study skills and/or learning strategies | ¨ Identify the issues ¨ Create a climate of support ¨ Ensure access to support that the student has agreed to ¨ Appropriately structure the assessment ¨ Provide information or course materials in accessible format, e.g. a textbook in braille ¨ Changes in teaching practices, e.g. wearing an FM microphone to enable a student to hear lectures ¨ Supply of specialised equipment or services, e.g. a note- taker for a student who cannot write ¨ Changes in lecture schedules and arrangements, e.g. relocating classes to an accessible venue ¨ Changes to course design, e.g. substituting an assessment task ¨ Modifications to physical environment, e.g. installing lever taps, building ramps, installing a lift |
| Explanation of reasonable adjustments strategy used (If required) |
What if you disagree on the assessment outcome?
You can appeal against a decision made in regards to your assessment. An appeal should only be made if you have been assessed as ‘Not Yet Competent’ against a specific unit and you feel you have sufficient grounds to believe that you are entitled to be assessed as competent. You must be able to adequately demonstrate that you have the skills and experience to be able to meet the requirements of units you are appealing the assessment of.
Your trainer will outline the appeals process, which is available to the student. You can request a form to make an appeal and submit it to your trainer, the course coordinator, or the administration officer. The AHIC will examine the appeal and you will be advised of the outcome within 14 days. Any additional information you wish to provide may be attached to the appeal form.
Academic Integrity:
Academic Integrity is about the honest presentation of your academic work. It means acknowledging the work of others while developing your own insights, knowledge and ideas.
As a student, you are required to:
- Undertake studies and research responsibly and with honesty and integrity
- Ensure that academic work is in no way falsified
- Seek permission to use the work of others, where required
- Acknowledge the work of others appropriately
- Take reasonable steps to ensure other students cannot copy or misuse your work.
Plagiarism:
Plagiarism means to take and use another person’s ideas and or manner of expressing them and to pass them off as your own by failing to give appropriate acknowledgement. This includes material sourced from the Internet, RTO staff, other students, and from published and unpublished work.
Plagiarism occurs when you fail to acknowledge that the ideas or work of others are being used, which includes:
- Paraphrasing and presenting work or ideas without a reference
- Copying work either in whole or in part
- Presenting designs, codes or images as your own work
- Using phrases and passages verbatim without quotation marks or referencing the author or web page
- Reproducing lecture notes without proper acknowledgement.
Collusion:
Collusion means unauthorized collaboration on assessable work (written, oral or practical) with other people. This occurs when a student presents group work as their own or as the work of someone else.
Collusion may be with another RTO student or with individuals or student’s external to the RTO. This applies to work assessed by any educational and training body in Australia or overseas.
Collusion occurs when you work without the authorization of the teaching staff to:
- Work with one or more people to prepare and produce work
- Allow others to copy your work or share your answer to an assessment task
- Allow someone else to write or edit your work (without rto approval)
- Write or edit work for another student
- Offer to complete work or seek payment for completing academic work for other students.
Both collusion and plagiarism can occur in group work. For examples of plagiarism, collusion and academic misconduct in group work please refer to the RTO’s policy on Academic integrity, plagiarism and collusion.
Plagiarism and collusion constitute cheating. Disciplinary action will be taken against students who engage in plagiarism and collusion as outlined in RTO’s policy.
Proven involvement in plagiarism or collusion may be recorded on students’ academic file and could lead to disciplinary action.
Assessment Formatting and Answer length Guidance:
Your submitted document must follow the given criteria:
- Font must be Times New Roman, Font size need to be 12 and line spacing has to be Single line.
- Your assessment needs to be submitted as an electronic copy unless requested differently by your assessor.
- The Assessment file name for electronic copy should follow :
Student Id_Assessment_No (Example AHI000014_Assessment 1)
Referencing
Include a reference list at the end of your work on a separate page or as footnotes. You should reference the sources you have used in your assessments in the Harvard Style.
To access a web-based tool, see Harvard Style online generator
http://www.harvardgenerator.com
Assessment Task 2: Skills Test
This project task requires you to demonstrate evidence of the ability to establish client needs and requirements, design and develop two technical documents, update the document with client feedback and prepare documentations for publication.
This assessment task is divided into five (5) main activities:
Activity 1: Establish client needs and requirements
Activity 2: Design and develop technical documentation
Activity 3: Participate in the consultation process
Activity 4: Update the document with client feedback
Activity 5: Prepare documentation for publication
You are completing these activities to prepare two (2) technical documentations, one for a website project and second a mobile application.
The website project requires you making a number of changes and writing web content that recognize all the cultural differences and diversity.
The mobile application project also requires you to understand the information provided, make a number of changes, as required and develop a technical document that recognize all the cultural differences and diversity.
To complete this assessment task, you must consider the background scenario and other information provided throughout this assessment activity.
Background scenario for website project:
It all started back in 2017 when Hi Fi Travels. was founded on the sunny Gold Coast, Australia. Since then they have become one of the Australia’s leading and largest travel brands that focuses on cultural exchange and to date have assisted over 30,000 travelers in turning their travel dreams into reality.
Their vision is to allow their customers the opportunity to experience the Australian cities not just as a tourist, but, become part of it, cultures and create what would have once been unimaginable moments come true.
Australian company Hi Fi Travels, however, is experiencing a number of issues such as:
- content is written mostly for Australian audience whereas most of its end-users are overseas people (especially living in China and Saudi Arabia) to travel to Australia.
- The company use dynamic type of main menu for navigation whereas Chinese clients prefer a static web menu
- There are a number of sub menus and some items going more than 2 choices whereas clients from China and Saudi Arabia prefer navigation panel without sub menus.
- Website content had a lot of information and pictures of young individuals whereas most of the clients from China and Saudi Arabia are above 50+ years of age.
- Clients from China and Saudi Arabia prefer high use of visible items, high display density in the web layout. Their preference for navigation includes more than 10 visible links on the main menu. They like high use of links, inks to open in new window, use of external links, image/ test animation and scrolling, use of images, bright colours with traditional colours, se of bold and headings and the content should be written in “simple English” catering information about Sydney, Melbourne, Gold Coast and 2 other Australian cities including public transportation, local accommodation and at-least 10 must-visit attractions.
Background Research:
Numerous studies have identified links among culture, user preferences, and Web site usability. Most of these studies were reports of findings from a behavioral perspective in explaining how cultural factors affect processes of Web‐related content design and use. Based on the research of Vygotsky and Nisbett, the authors propose a broader model, referred to as “cultural cognition theory,” by which Web design, like other types of information production, is seen as being shaped by cultural cognitive processes that impact the designers’ cognitive style. This study explores issues related to Web designers’ cultural cognitive styles and their impact on user responses. The results of an online experiment that exposed American and Chinese users to sites created by both Chinese and American designers indicate that users perform information‐seeking tasks faster when using Web content created by designers from their own cultures. Read more about the research at https://onlinelibrary.wiley.com/doi/full/10.1111/j.1083-6101.2006.tb00318.x#fn1
To complete this assessment task students are required to participate in a meeting using the template provided:
When conducting the meeting, you are required to:
The team member will:
After the meeting, you are then required to:
Background scenario for mobile application:
We will be using the same organization case study but entirely a different ICT product i.e. mobile application for developing the second technical document.
It all started back in 2017 when Hi Fi Travels. was founded on the sunny Gold Coast, Australia. Since then they have become one of the Australia’s leading and largest travel brands that focuses on cultural exchange and to date have assisted over 30,000 travelers in turning their travel dreams into reality.
Their vision is to allow their customers the opportunity to experience the Australian cities not just as a tourist, but, become part of it, cultures and create what would have once been unimaginable moments come true.
Australian company Hi Fi Travels, however, is experiencing a number of issues such as:
- content is written mostly for Australian audience whereas most of its end-users are overseas people (especially living in China and Saudi Arabia) to travel to Australia.
- The company use mobile application that has not been updated to meet the latest changes of application hosting platforms
- The screen size and device compatibility is an ongoing issue.
- Mobile application does not provide online booking facilities.
- Mobile application marketing does not align with organizational policies and procedures.
Background Research:
In its new reporthttps://www.appsflyer.com/resources/the-state-of-app-marketing-h2-2015/, mobile ad attribution vendor Apps Flyer analyzed more than 1.1 billion paid installs of over 6,000 apps during the last 6 months to see what works and what doesn’t. When it comes to mobile app marketing, iOS and Android users show some striking differences across the hundreds of attributes (location, content preference, behavioral demographic, etc.). The report covers click-to-install data and retention (how long someone uses the app over one week, one month) for both iOS and Android users around the world in key app categories – including gaming, productivity, and music.
The Apps Flyer report also shows just how differently Android and iOS users behave around certain app categories. For instance, iOS users are almost four times as likely to convert and to become high-value customers in the health and fitness category — whereas Android users are far more loyal in terms of travel, entertainment, and utility apps.
The traditional thinking has been that iOS users tend to be more affluent (tending to buy more expensive Apple devices more frequently). As it turns out, these users are also more inclined to install and engage with apps during prime ‘leisure’ hours — evenings and weekends.
That same data point couldn’t be more diverse and nuanced across different cultures, however — Asian users’ highest levels of engagement are on Fridays, while Latin American users favor Tuesdays, for example. Latin Americans also engage with apps in far later hours of the evening — peaking around 11 p.m. or so, whereas most other countries see peak usage between 6 p.m and 8 p.m.
To complete this assessment task students are required to participate in a meeting using the template provided:
When conducting the meeting, you are required to:
The team member will:
After the meeting, you are then required to:
Meeting agenda template – 1:
| Date/Time: | |||
| Location: | |||
| Chairperson: | |||
| Meeting Attendees: Full names and roles | |||
| Agenda Item/Topic | Discussion/Outcomes | Action Officer | Due Date |
| Welcome | |||
| (Agenda item 1) Topic? | |||
| (Agenda item 2) Topic? | |||
| (Agenda item 3) Topic? | |||
| Summary | Overall Summary Decision/s Action/s if any | ||
| Next Meeting time/date | |||
| Meeting closed at: | |||
| Minutes are a true and accurate record of the meeting | Approved/confirmed by whom? |
Meeting minutes template – 1:
| Minutes of Meeting Meeting Objective: Attendees: Venue: Date: | |||
| No. | Points Discussed | Actions Suggested | Target Date |
| Signature of attendee 1: Signature of attendee 2: Signature of attendee 3: Signature of attendee 4: |
Meeting agenda template – 2:
| Date/Time: | |||
| Location: | |||
| Chairperson: | |||
| Meeting Attendees: Full names and roles | |||
| Agenda Item/Topic | Discussion/Outcomes | Action Officer | Due Date |
| Welcome | |||
| (Agenda item 1) Topic? | |||
| (Agenda item 2) Topic? | |||
| (Agenda item 3) Topic? | |||
| Summary | Overall Summary Decision/s Action/s if any | ||
| Next Meeting time/date | |||
| Meeting closed at: | |||
| Minutes are a true and accurate record of the meeting | Approved/confirmed by whom? |
Meeting minutes template – 2:
| Minutes of Meeting Meeting Objective: Attendees: Venue: Date: | |||
| No. | Points Discussed | Actions Suggested | Target Date |
| Signature of attendee 1: Signature of attendee 2: Signature of attendee 3: Signature of attendee 4: |
Activity 1: Establish client needs and requirements (300-400 words)
For this assessment activity, you must establish client needs and requirements based upon the information provided through background scenario, background research and write client interviews.
The information collected through this assessment activity will be useful to proceed to Activity 2.
Assessment criteria and conditions for website project:
You are required to develop the web content for the web pages.
Your web pages must meet the following criteria:
- Recognize all the cultural differences and diversity as mentioned in the background scenario and background research sections.
- Prepare contents for the following web pages:
- The content of all pages should be free from copyright and Intellectual property (IP) related issues.
- Student use style guide and micro-content elements according to the requirements described in the background scenario and assessment criteria and conditions.
- Student must prepare a templates and style guides for all web pages.
- Web content is written according to the principles of design principles and organizational requirements.
- Student must use a word-processing and web development software such as Dreamweaver to develop the website.
- Student select the content channels and format as part of client requirements.
- Student must meet organizational documentation as mentioned through the prominent design elements and industry requirements and standards.
- You must research the running costs and other aspects mentioned in the “Client Interview Form” for a basic 8 to 10 pages website for this assessment activity.
- The content must meet the following design attributes and design elements guidelines:
Prominent Design Elements
| Design attributes | Prominent design elements | A | C | SA |
| Layout | High use of visible items | |||
| Layout | High display density– | |||
| Navigation | Dynamic type of main menu (Mm) | |||
| Navigation | More than 10 visible links in the Mm | |||
| Navigation | Level of 2 choices in the Mm | |||
| Navigation | Fat footer | |||
| Links | High use of links | |||
| Links | Links open in a new window | |||
| Links | External links | |||
| Multimedia | Image/ text animation | |||
| Multimedia | Image/ text scrolling | |||
| Multimedia | Use of images | |||
| Vis. Rep. | Image of young individuals | |||
| Vis. Rep. | Images of leader | |||
| Vis. Rep. | Image of political | |||
| Colour | Bright colours with traditional colours | |||
| Text | Use of bold | |||
| Text | Use of headings |
Where: Vis. Rep. = Visual representation, Mm= Main menu, A=Australia, C=China, and SA=Saudi Arabia.
Note: + Use of items includes: headings, links, and images.
– Display density = total number of items / web page length.
* For the design attribute navigation, in the Saudi Arabian culture, the
usage differences of both: ‘Static’ and ‘Dynamic’ were more than 40%. It was then decided to take the highest value.
Your trainer/assessor will play the role of overseas client. You are required to record all answers in “Comments and findings” section of the attached template:
| Client Interview Form | Comments and findings | |
| Purpose of the Interview | Finding out the requirements for developing technical documentation for website development | |
| Operational characteristics | Present the background to, and rationale for, requirements for such things as Changes required Reliability, availability, recovery Confidentiality, security Running costs (e.g. consumables) | |
| Control, support and maintenance | Specify the presumed mode of organization and execution of system operation, support, and maintenance, as background to, and rationale for, requirements for such things as System set-up Instrumentation, accounting, tuning Change management, configuration management, release control Etc. | |
| System architecture and construction | Technology and knowledge required Describe any items that will limit the developers’ options for building the system. This section should not be used to impose specific requirements or specific design constraints but should state the reasons why certain requirements or constraints exist. Requirements and constraints may be geographical or political. | |
| Assumptions and dependencies | List the assumptions that the specific requirements are based on. Risk analysis should be used to identify assumptions that may not prove to be valid. For example, an interface may be specified with a system that does not yet exist. If the production of the system does not occur when expected, this document may have to change. |
Assessment criteria and conditions for mobile application:
You are required to develop the content for the mobile application.
Discuss the requirements with your trainer/assessor based on the information provided in the case study:
| Requirements | Comments and findings |
| Target audience | |
| Navigation patterns (Visit https://developer.apple.com/ios/human-interface-guidelines/interaction/navigation/ for more information) | |
| Content optimization requirements for mobile phone application | |
| Operational characteristics | |
| Control, support and maintenance | |
| System architecture and construction | |
| Assumptions and dependencies |
Activity 2: Design and develop technical documentation (300-400 words)
In this assessment activity, you must design and develop technical documentation according to the client needs and requirements based upon the information provided through background scenario, background research and write client interviews.
The information collected through this assessment activity will be useful to proceed to Activity 3.
Assessment criteria and conditions for website project:
You are required to develop the technical documentation to:
- Develop content for the website
- Ensuring client specifications are met
- Writing the requirements for developing a website
- Present the background to, and rationale for, requirements for such things as
- Changes required
- Reliability, availability, recovery
- Confidentiality, security
- Running costs (e.g. consumables)
- Present the background to, and rationale for, requirements for such things as
- Specify the presumed mode of organization and execution of system operation, support, and maintenance, as background to, and rationale for, requirements for such things as
- System set-up
- Instrumentation, accounting, tuning
- Change management, configuration management, release control
- Etc.
- System architecture and construction
- Technology and knowledge required
- Describe any items that will limit the developers’ options for building the system.
- This section should not be used to impose specific requirements or specific design constraints but should state the reasons why certain requirements or constraints exist. Requirements and constraints may be geographical or political.
- Assumptions and dependencies
- List the assumptions that the specific requirements are based on.
- Risk analysis should be used to identify assumptions that may not prove to be valid. For example, an interface may be specified with a system that does not yet exist. If the production of the system does not occur when expected, this document may have to change.
You must complete the attached technical documentation template to complete this assessment activity.
| 1. Hardware Requirements (If applicable) | |
| ID | Requirements |
| 1.1 | Hardware Requirement List the hardware requirements, if any. Example:256 MB Ram |
| 2. Software Requirements (If applicable) | |
| ID | Requirements |
| 2.1 | Software Requirement List the software requirements, if any. Example:Operating system: Windows 7 |
| 3. Technical Requirements |
Technical requirements are giving information to the developers as to what the system must adhere to. These are guidelines that can have implications over on the developer’s way of developing a code. For a successful development process identification of the correlation between the functional requirements and corresponding technical requirements/constraints is essential. Best practice to write technical requirements is to address each and every functional requirement mentioned in the business requirements document (BRD). Use one table for each requirement identified from the BRD.
| 3.1. Functional Requirements | ||
| Functional Req ID | Technical Req ID # | Technical Requirements |
| 3.1. | 3.1.1 | Technical Requirement How is the functional requirement implemented technically? Example: For a Registration/Login page, |
| 3.2. Reporting Requirements (If applicable) | ||
| Reporting Req ID # (From BRD) | Technical Req ID # | Technical Requirements |
| 3.2. | 3.2.1 | Reporting Requirement List the reporting requirements, if any. Example:Select X, Y, Z from XXX table between date=YYY and date=ZZZ |
| 3.3. Security Requirements (If applicable) | ||
| Security Req ID # (From BRD) | Technical Req ID # | Requirements |
| 3.3. | 3.3.1 | Security Requirement List the security requirements, if any. Example: Use XXX algorithm for encryption. |
4 Technical Process Flow
Insert process flows, if any.
5. Addendums & Appendices
Include any additional documents/ information.
ICTICT435 Create technical documentation Assessment 1 ICT50220
Assessment criteria and conditions for mobile application:
You are required to develop the technical documentation to:
- Discuss the purpose using a few sentences
- Document conventions: terms and definitions in the document.
- Intended audience: descriptions of the different types of readers the document is intended for.
- Project scope: a brief description of the software features related to business needs.
- Product perspective: the description of the context and origin of the product prepared in a special form.
- Product features: all the characteristics that will be implemented in the app in a short table view.
- User roles and rights: the description of user classes in a brief table view.
- Operating environment: hardware and software platforms, other products that need to be considered.
- Design and Implementation Constraints: Anything that marginalizes the outside-the-box thinking of developers and designers.
- User documents: A list of user-related documents that will be released along with the app.
- Assumptions and Dependencies: Here you can place anything that is still not clear to classify in the current stage.
You must complete the attached technical documentation template to complete this assessment activity.
| 1. Hardware Requirements (If applicable) | |
| ID | Requirements |
| 1.1 | Hardware Requirement List the hardware requirements, if any. Example:256 MB Ram |
| 2. Software Requirements (If applicable) | |
| ID | Requirements |
| 2.1 | Software Requirement List the software requirements, if any. Example:Operating system: Windows 7 |
| 3. Technical Requirements |
Technical requirements are giving information to the developers as to what the system must adhere to. These are guidelines that can have implications over on the developer’s way of developing a code. For a successful development process identification of the correlation between the functional requirements and corresponding technical requirements/constraints is essential. Best practice to write technical requirements is to address each and every functional requirement mentioned in the business requirements document (BRD). Use one table for each requirement identified from the BRD.
| 3.1. Functional Requirements | ||
| Functional Req ID | Technical Req ID # | Technical Requirements |
| 3.1. | 3.1.1 | Technical Requirement How is the functional requirement implemented technically? Example: For a Registration/Login page, |
| 3.2. Reporting Requirements (If applicable) | ||
| Reporting Req ID # (From BRD) | Technical Req ID # | Technical Requirements |
| 3.2. | 3.2.1 | Reporting Requirement List the reporting requirements, if any. Example:Select X, Y, Z from XXX table between date=YYY and date=ZZZ |
| 3.3. Security Requirements (If applicable) | ||
| Security Req ID # (From BRD) | Technical Req ID # | Requirements |
| 3.3. | 3.3.1 | Security Requirement List the security requirements, if any. Example: Use XXX algorithm for encryption. |
4 Technical Process Flow
Insert process flows, if any.
5. Addendums & Appendices
Include any additional documents/ information.
Activity 3: Participate in the consultation process (300-400 words)
In this assessment activity, you must participate in a consultation process to:
- Evaluate the technical documentation prepared as previous assessment activity
- Provide suggestions to develop revised technical documentation according to the client needs and requirements based upon the information provided through background scenario, background research and write client interviews.
- Completed technical documentation meets client requirements and scope of work
- Technical documentation is error free, plagiarism free also free from any copyright related issues.
The information collected through this assessment activity will be useful to proceed to Activity 4 and 5.
Assessment criteria and conditions for website project:
You are required to participate in the consultation process with your overseas client.
The consultation process will be based upon the technical documentation prepared as part of Assessment Activity 2 and requirements gathered through Assessment Activity 1.
You must use the attached client Interview form to participate in the consultation process.
| Client Interview Form | Comments and findings | |
| Purpose of the Interview | Finding out the requirements for developing technical documentation for website development | |
| Operational characteristics | Present the background to, and rationale for, requirements for such things as Changes required Reliability, availability, recovery Confidentiality, security Running costs (e.g. consumables) | |
| Control, support and maintenance | Specify the presumed mode of organization and execution of system operation, support, and maintenance, as background to, and rationale for, requirements for such things as System set-up Instrumentation, accounting, tuning Change management, configuration management, release control Etc. | |
| System architecture and construction | Technology and knowledge required Describe any items that will limit the developers’ options for building the system. This section should not be used to impose specific requirements or specific design constraints but should state the reasons why certain requirements or constraints exist. Requirements and constraints may be geographical or political. | |
| Assumptions and dependencies | List the assumptions that the specific requirements are based on. Risk analysis should be used to identify assumptions that may not prove to be valid. For example, an interface may be specified with a system that does not yet exist. If the production of the system does not occur when expected, this document may have to change. |
Your trainer/assessor will act as one of your overseas clients and you must confirm and get approval from him/her before you update the technical document.
Assessment criteria and conditions for mobile application:
You are required to participate in the consultation process with your overseas client.
The consultation process will be based upon the technical documentation prepared as part of Assessment Activity 2 and requirements gathered through Assessment Activity 1.
You must use the attached client Interview form to participate in the consultation process.
| Client Interview Form | Comments and findings | |
| Purpose of the Interview | Finding out the requirements for developing technical documentation for mobile application | |
| Operational characteristics | Present the background to, and rationale for, requirements for such things as Changes required Reliability, availability, recovery Confidentiality, security Running costs (e.g. consumables) | |
| Control, support and maintenance | Specify the presumed mode of organization and execution of system operation, support, and maintenance, as background to, and rationale for, requirements for such things as System set-up Instrumentation, accounting, tuning Change management, configuration management, release control Etc. | |
| System architecture and construction | Technology and knowledge required Describe any items that will limit the developers’ options for building the system. This section should not be used to impose specific requirements or specific design constraints but should state the reasons why certain requirements or constraints exist. Requirements and constraints may be geographical or political. | |
| Assumptions and dependencies | List the assumptions that the specific requirements are based on. Risk analysis should be used to identify assumptions that may not prove to be valid. For example, an interface may be specified with a system that does not yet exist. If the production of the system does not occur when expected, this document may have to change. |
Your trainer/assessor will act as one of your overseas clients and you must confirm and get approval from him/her before you update the technical document.
Activity 4: Update the document with client feedback (300-400 words)
In this assessment activity, you are required to update the document with client feedback and ensure:
- Revised technical documentation is developed according to the client needs and requirements based upon the information provided through background scenario, background research and write client interviews.
- Completed technical documentation meets client requirements and scope of work
The information collected through this assessment activity will be useful to proceed to Activity 5.
Assessment criteria and conditions for website project:
You are required to participate in the consultation process with your overseas client.
Your trainer/assessor should fill the attached below checklist to ensure the content is appropriate to be published.
| Has the student | Yes | No/ provide comments for improvement |
| Written content in a clear, easy-to-read, easy-to-access manner | ||
| Content is free from copyright and any intellectual property related issues. | ||
| Content is written to ensure it promotes and recognizes the cultural differences and diversity | ||
| Developed content according to Industry requirements |
Any changes suggested by trainer/assessor must be implemented before beginning assessment activity 5.
You will be assessed according to the following criteria:
| Performance criteria | Meet the requirement | Does not meet the requirement | Comments |
| Identify the customer information needs in terms of: Cultural differences Site functionality Client requirements | |||
| Confirm the following from trainer/assessor: Site purpose Site functionality Client specifications | |||
| Obtain the templates and style guides | |||
| Identify the content and analyze it through: Client specifications Maintenance requirements Information architecture Site design functionality | |||
| Negotiate any alterations to site design and make changes as required. |
Assessment criteria and conditions for mobile application:
You are required to participate in the consultation process with your overseas client.
Your trainer/assessor should fill the attached below checklist to ensure the content is appropriate to be published.
| Has the student | Yes | No/ provide comments for improvement |
| Written content in a clear, easy-to-read, easy-to-access manner | ||
| Content is free from copyright and any intellectual property related issues. | ||
| Content is written to ensure it promotes and recognizes the cultural differences and diversity | ||
| Developed content according to Industry requirements |
Any changes suggested by trainer/assessor must be implemented before beginning assessment activity 5.
You will be assessed according to the following criteria:
| Performance criteria | Meet the requirement | Does not meet the requirement | Comments |
| Identify the customer information needs in terms of: Cultural differences Site functionality Client requirements | |||
| Confirm the following from trainer/assessor: Application purpose Application functionality Client specifications | |||
| Obtain the templates and style guides | |||
| Identify the content and analyze it through: Client specifications Maintenance requirements Information architecture Mobile application design functionality | |||
| Negotiate any alterations to application design and make changes as required. |
Activity 5: Prepare documentation for publication (300-400 words)
In this assessment activity, you are required to prepare documentation for publication by ensuring
- Revised technical documentation is provided to your trainer/assessor for final review and publication.
- The reviewed technical documentation is developed according to the client needs and requirements based upon the information provided through background scenario, background research and write client interviews.
- Completed technical documentation meets client requirements and scope of work.
Assessment criteria and conditions for website project:
You are required to prepare documentation for publication with your overseas client.
You must complete the attached template to get approval from your trainer/assessor.
| Publication of technical documentation form | |
| Media source for publication | |
| Operational characteristics | |
| Control, support and maintenance | |
| System architecture and construction | |
| Assumptions and dependencies | |
| Final technical documentation | |
The End