PV177 Laboratory of Advanced Network Technologies

Fakulta informatiky
jaro 2023
Rozsah
0/2/0. 2 kr. Ukončení: z.
Vyučováno prezenčně.
Vyučující
doc. RNDr. Eva Hladká, Ph.D. (přednášející)
RNDr. Tomáš Rebok, Ph.D. (přednášející)
RNDr. Martin Ukrop, Ph.D. (přednášející)
Ing. Šárka Jana Janderková (cvičící)
Mgr. Alexandra Nikandrova (cvičící)
Garance
doc. RNDr. Eva Hladká, Ph.D.
Katedra počítačových systémů a komunikací – Fakulta informatiky
Kontaktní osoba: doc. RNDr. Eva Hladká, Ph.D.
Dodavatelské pracoviště: Katedra počítačových systémů a komunikací – Fakulta informatiky
Rozvrh seminárních/paralelních skupin
PV177/TechWriting: Út 14. 2. až Út 9. 5. Út 12:00–13:50 S505, Š. Janderková, A. Nikandrova, M. Ukrop
Předpoklady
SOUHLAS
PV177/TechWriting (Technical writing) -- the class will be delivered in English, no other prerequisites
Omezení zápisu do předmětu
Předmět je nabízen i studentům mimo mateřské obory.
Mateřské obory/plány
předmět má 76 mateřských oborů, zobrazit
Cíle předmětu
Seznámení se s oblastí a (týmový) projekt zaměřený na osvojení si principů v jedné z oblastí, na kterou je kurz v daném semestru specializován.
V aktuálním semestru je kurz specializován na následující oblast:
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.
Výstupy z učení
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.
Osnova
  • 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)
Literatura
  • https://www.knime.com/knime-analytics-platform
Výukové metody
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
Metody hodnocení
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
Vyučovací jazyk
Angličtina
Informace učitele
https://github.com/rh-writers/technical-writing-course-brno
Další komentáře
Studijní materiály
Předmět je vyučován každý semestr.
Předmět je zařazen také v obdobích podzim 2005, jaro 2006, podzim 2006, jaro 2007, podzim 2007, jaro 2008, podzim 2008, jaro 2009, podzim 2009, jaro 2010, podzim 2010, jaro 2011, podzim 2011, jaro 2012, podzim 2012, jaro 2013, podzim 2013, jaro 2014, podzim 2014, jaro 2015, podzim 2015, jaro 2016, podzim 2016, jaro 2017, podzim 2017, jaro 2018, podzim 2018, jaro 2019, podzim 2019, jaro 2020, podzim 2020, jaro 2021, podzim 2021, jaro 2022, podzim 2022, podzim 2023, jaro 2024.