Technical DocumentationLaajuus (3 cr)
Code: IT23CS01
Credits
3 op
Objective
The student:
- can report and document within the area of competence.
- is familiar with writing and layout rules and knows the style level that is appropriate in a formal text.
- can plan an assignment and make associated documentation using critically selected sources of various kinds.
- knows how to document practical and theoretical knowledge in the field of study.
- master one or more reference systems.
Content
- Information retrieval
- the work process for more extensive reporting such as degree projects
- reference systems
- evaluation of reports
- rules for written reports and scientific work.
- Application according to specific education may occur.
Qualifications
Inga förkunskapskrav
Assessment criteria, approved/failed
Reporting: Ability to report and document within the area of expertise. They master writing and layout rules that mark documentation
degree level and know the style level that is appropriate in a formal reporting text in the field of technology.
Scientific writing: Have the readiness to plan and complete a comprehensive development and project assignment and know the work process for scientific writing. Have the readiness to present well-founded arguments and conclusions. Know and can use writing manuals. Can use one or more reference systems. Reading and reviewing: Ability to critically read and review reports in the area of competence and prepare for oral counselling.
Information search: Ability to critically and systematically search sources and access them in content for written and oral assignments in the area of competence.
Enrollment
01.12.2024 - 05.01.2025
Timing
06.01.2025 - 16.03.2025
Number of ECTS credits allocated
3 op
Mode of delivery
Contact teaching
Teaching languages
- English
Degree programmes
- Degree Programme in Information Technology
Teachers
- Hanna Kuusisto
Teacher in charge
Kaj Wikman
Groups
-
ITE24D-VInformation Technology, day time studies 2024, Vasa
Objective
The student:
- can report and document within the area of competence.
- is familiar with writing and layout rules and knows the style level that is appropriate in a formal text.
- can plan an assignment and make associated documentation using critically selected sources of various kinds.
- knows how to document practical and theoretical knowledge in the field of study.
- master one or more reference systems.
Content
- Information retrieval
- the work process for more extensive reporting such as degree projects
- reference systems
- evaluation of reports
- rules for written reports and scientific work.
- Application according to specific education may occur.
Location and time
Please see the schedule for more detailed information
Teaching methods
This course equips students with essential skills for effective technical communication. Students will learn to create clear and user-friendly technical documentation across various formats. By the course's end, students will be proficient in producing quality technical documentation and enhancing their employability in technical communication roles.
Teaching methods: contact studies
Prerequisites: None
Exam schedules
FInal exam
Student workload
27 hours individual workload per 1 credit (a total of 3 ETCS)
Evaluation scale
H-5
Assessment criteria, approved/failed
Reporting: Ability to report and document within the area of expertise. They master writing and layout rules that mark documentation
degree level and know the style level that is appropriate in a formal reporting text in the field of technology.
Scientific writing: Have the readiness to plan and complete a comprehensive development and project assignment and know the work process for scientific writing. Have the readiness to present well-founded arguments and conclusions. Know and can use writing manuals. Can use one or more reference systems. Reading and reviewing: Ability to critically read and review reports in the area of competence and prepare for oral counselling.
Information search: Ability to critically and systematically search sources and access them in content for written and oral assignments in the area of competence.
Assessment methods and criteria
Continuous assessment: students are assessed throughout the course
-participation in in-class activities, individual assignments, group work, and final exam
Assessment criteria, fail (0)
Lack of attendance, incompleted assignments, failed final exam.
Assessment criteria, satisfactory (1-2)
Students who receive a grade of 1 or 2 demonstrate a below-average understanding of the course material. Their technical documentation may lack clarity, organization, or usability. Their work shows a limited application of technical writing principles. They may have difficulty actively participating in class discussions or meeting expectations consistently.
Assessment criteria, good (3-4)
Students who receive a grade of 3 demonstrate an acceptable level of understanding of the course material. They produce technical documentation that meets basic requirements in terms of clarity, organization, and usability. While there may be some room for improvement, their work reflects a satisfactory application of technical writing principles. They participate adequately in class discussions and meet most expectations.
Students who receive a grade of 4 consistently demonstrate a solid understanding of the course material. They consistently produce high-quality technical documentation that is clear, well-organized, and user-friendly. Their work shows proficiency in applying technical writing principles and best practices. They actively participate in class discussions, contribute valuable insights, and consistently meet or exceed expectations.
Assessment criteria, excellent (5)
Students who receive a grade of 5 consistently demonstrate exceptional mastery of the course material. They consistently produce outstanding technical documentation that showcases clarity, organization, and usability. Their work exhibits a deep understanding of the principles and best practices of technical writing. They actively participate in class discussions, engage in critical thinking, and consistently exceed expectations.
Qualifications
Inga förkunskapskrav
Enrollment
14.12.2023 - 05.01.2024
Timing
08.01.2024 - 25.02.2024
Number of ECTS credits allocated
3 op
Mode of delivery
Contact teaching
Unit
Faculty of Technology and Seafaring
Teaching languages
- English
Degree programmes
- Degree Programme in Information Technology
- Degree Programme in Information Technology
Teachers
- Hanna Kuusisto
Teacher in charge
Kaj Wikman
Groups
-
ITE23D-VInformation Technology, full time studies 2023, Vasa
Objective
The student:
- can report and document within the area of competence.
- is familiar with writing and layout rules and knows the style level that is appropriate in a formal text.
- can plan an assignment and make associated documentation using critically selected sources of various kinds.
- knows how to document practical and theoretical knowledge in the field of study.
- master one or more reference systems.
Content
- Information retrieval
- the work process for more extensive reporting such as degree projects
- reference systems
- evaluation of reports
- rules for written reports and scientific work.
- Application according to specific education may occur.
Location and time
Please see the schedule for more detailed information
Teaching methods
This course equips students with essential skills for effective technical communication. Students will learn to create clear and user-friendly technical documentation across various formats. By the course's end, students will be proficient in producing quality technical documentation and enhancing their employability in technical communication roles.
Teaching methods: contact studies
Prerequisites: None
Exam schedules
FInal exam
Student workload
27 hours individual workload per 1 credit (a total of 3 ETCS)
Evaluation scale
H-5
Assessment criteria, approved/failed
Reporting: Ability to report and document within the area of expertise. They master writing and layout rules that mark documentation
degree level and know the style level that is appropriate in a formal reporting text in the field of technology.
Scientific writing: Have the readiness to plan and complete a comprehensive development and project assignment and know the work process for scientific writing. Have the readiness to present well-founded arguments and conclusions. Know and can use writing manuals. Can use one or more reference systems. Reading and reviewing: Ability to critically read and review reports in the area of competence and prepare for oral counselling.
Information search: Ability to critically and systematically search sources and access them in content for written and oral assignments in the area of competence.
Assessment methods and criteria
Continuous assessment: students are assessed throughout the course
-participation in in-class activities, individual assignments, group work, and final exam
Assessment criteria, fail (0)
Lack of attendance, incompleted assignments, failed final exam.
Assessment criteria, satisfactory (1-2)
Students who receive a grade of 1 or 2 demonstrate a below-average understanding of the course material. Their technical documentation may lack clarity, organization, or usability. Their work shows a limited application of technical writing principles. They may have difficulty actively participating in class discussions or meeting expectations consistently.
Assessment criteria, good (3-4)
Students who receive a grade of 3 demonstrate an acceptable level of understanding of the course material. They produce technical documentation that meets basic requirements in terms of clarity, organization, and usability. While there may be some room for improvement, their work reflects a satisfactory application of technical writing principles. They participate adequately in class discussions and meet most expectations.
Students who receive a grade of 4 consistently demonstrate a solid understanding of the course material. They consistently produce high-quality technical documentation that is clear, well-organized, and user-friendly. Their work shows proficiency in applying technical writing principles and best practices. They actively participate in class discussions, contribute valuable insights, and consistently meet or exceed expectations.
Assessment criteria, excellent (5)
Students who receive a grade of 5 consistently demonstrate exceptional mastery of the course material. They consistently produce outstanding technical documentation that showcases clarity, organization, and usability. Their work exhibits a deep understanding of the principles and best practices of technical writing. They actively participate in class discussions, engage in critical thinking, and consistently exceed expectations.
Qualifications
Inga förkunskapskrav