PV177 Laboratory of Advanced Network Technologies

Faculty of Informatics
Spring 2023
Extent and Intensity
0/2/0. 2 credit(s). Type of Completion: z (credit).
Teacher(s)
doc. RNDr. Eva Hladká, Ph.D. (lecturer)
RNDr. Tomáš Rebok, Ph.D. (lecturer)
RNDr. Martin Ukrop, Ph.D. (lecturer)
Ing. Šárka Jana Janderková (seminar tutor)
Mgr. Alexandra Nikandrova (seminar tutor)
Guaranteed by
doc. RNDr. Eva Hladká, Ph.D.
Department of Computer Systems and Communications – Faculty of Informatics
Contact Person: doc. RNDr. Eva Hladká, Ph.D.
Supplier department: Department of Computer Systems and Communications – Faculty of Informatics
Timetable of Seminar Groups
PV177/TechWriting: Tue 14. 2. to Tue 9. 5. Tue 12:00–13:50 S505, Š. Janderková, A. Nikandrova, M. Ukrop
Prerequisites
SOUHLAS
PV177/TechWriting (Technical writing) -- the class will be delivered in English, no other prerequisites
Course Enrolment Limitations
The course is also offered to the students of the fields other than those the course is directly associated with.
fields of study / plans the course is directly associated with
there are 76 fields of study the course is directly associated with, display
Course objectives
Familiarization with the area and practical (team) project aimed at adopting the principles in one of the areas, which the course is specialized on in the particular semester.
In current semester, the course is specialized in the following area:
1. PV177/TechWriting (Technical writing)
• Give students an overview of the technical writing industry, acquire knowledge and skills that are required for a technical writer job role.
• Prepare students to work with technical writers if they are working as developers.
• Prepare students to write better documentation for their future projects.
• Train purposeful, minimalist writing and clear communication.
Learning outcomes
1. PV177/TechWriting (Technical writing)
• Understand technical writing principles, goals, and audience.
• Participate actively in writing activities. Students will be able to produce a set of documents related to technology.
• Understand how to analyze data from research and incorporate it into assigned writing clearly, concisely, and logically.
• Edit documents with peer exchange according to professional guidelines.
• Get an overview of tools that are used in technical writing and learn more about cross-team collaboration.
Syllabus
  • 1. PV177/TechWriting (Technical writing):
    Beware, this seminar group runs only for 6 weeks (1st half of the semester).
    • Introduction to technical writing (definition and purpose of technical writing, comparison between different writing styles, a day in the life of a technical writer, types of technical documentation and their specifics, target audience)
    • Style (accessibility, minimalism, modularity and structure, user focus and information flow, style guides)
    • Soft skills (empathy, ethics, cultural awareness, communication skills, curiosity, proactivity, editorial skills, time management)
    • Hard skills (definition of hard skills in technical writing, why we need them, product knowledge, engagement with the development team. Understanding user personas, teamwork across QE, product owners, engineers, support teams, planning for tech writing, how to create technical content, content strategy)
    • Tools (introducing single sourced and modular documentation, advantages of using markup languages with the ability to set attributes and use conditions, overview of text editors, version control systems, and publishing tools, creating and generating documentation using AsciiDoc and AsciiDoctor)
    • Usability (usability of documented products, 10 usability heuristics, usability of documentation deliverables)
Literature
  • https://www.knime.com/knime-analytics-platform
Teaching methods
1. PV177/TechWriting (Technical writing):
Beware, this seminar group runs only for 6 weeks (1st half of the semester).
• Lecture - instructor presenting material and answering student questions (demonstration, slideshows)
• Interactive parts of the lecture for students activities (solving a problem, correct the error, compare and contrast, paraphrase the idea)
• Project based learning - students apply course knowledge to produce their own portfolio
Assessment methods
1. PV177/TechWriting (Technical writing):
• Written work to display writing skills, and to show application and evaluation capabilities
• Portfolio of student work to encourage student self-reflection and to determine student learning over time
• Performance and activity during the lectures - demonstration of acquired skills, and the ability to work collaboratively
Language of instruction
English
Further Comments
Study Materials
The course is taught each semester.
Teacher's information
https://github.com/rh-writers/technical-writing-course-brno
The course is also listed under the following terms Autumn 2005, Spring 2006, Autumn 2006, Spring 2007, Autumn 2007, Spring 2008, Autumn 2008, Spring 2009, Autumn 2009, Spring 2010, Autumn 2010, Spring 2011, Autumn 2011, Spring 2012, Autumn 2012, Spring 2013, Autumn 2013, Spring 2014, Autumn 2014, Spring 2015, Autumn 2015, Spring 2016, Autumn 2016, Spring 2017, Autumn 2017, Spring 2018, Autumn 2018, Spring 2019, Autumn 2019, Spring 2020, Autumn 2020, Spring 2021, Autumn 2021, Spring 2022, Autumn 2022, Autumn 2023, Spring 2024, Autumn 2024, Spring 2025.
  • Enrolment Statistics (Spring 2023, recent)
  • Permalink: https://is.muni.cz/course/fi/spring2023/PV177