BME VIK - Műszaki kommunikáció az iparban és a tudományos életben

3. A tantárgyfelelős személy és tanszék Dr. Kara Péter András,

4. A tantárgy előadója

Név:	Beosztás:	Tanszék, Int.:
Dr. Kara Péter András	egyetemi tanársegéd	HIT

7. A tantárgy célkitűzése A kurzus célja a modern műszaki dokumentáció szerkezetének, stílusának és modularitásának mélyreható megismertetése. E cél érdekében, bevezetést nyújt a műszaki szövegírás történetébe és alapelveibe, az információ gyűjtés és feldolgozás folyamataiba, a szerkesztésbe, a revideálási módszerekbe, a szövegek felhasználóra való optimalizálásába, valamint a kapcsolódó alapvető technológiákba. A kurzus sikeres elvégzése után a hallgató képes lesz a következőkre:
•   Hatékony műszaki dokumentumok tervezése mind a nyomtatott, mind a digitális média számára.
•   Átstrukturálni és átírni a kapott inputot a minőség és a felhasználói élmény javítása érdekében.
•   Megérteni a minőségi műszaki dokumentáció készítéséhez szükséges információáramlást.
•   Használni az információs architektúra különböző, a műszaki dokumentumok digitális környezetben történő felhasználására alkalmas eszközeit.
•   Megérteni és használni a műszaki íráshoz kapcsolódó technológiákát és eszközöket.
•   Felismerni a műszaki illusztráció és az „instructional design” jelentőséget a szövegírásban.

A kurzus emellett foglalkozik a műszaki írással az akadémiai szférában. Az erről szóló előadások célja olyan készségek fejlesztése, amelyek szükségesek a konferencia- és folyóiratcikkek minőségének javításához a műszaki kommunikáció szintjén, és ezáltal az ilyen kéziratok versenyképességének növelése a lektorált tudományos publikációkban.

8. A tantárgy részletes tematikája A kurzus célja, hogy felhasználóbarát műszaki dokumentáció létrehozásához és karbantartásához szükséges készségeket és ismereteket nyújtson. Ehhez a hallgatóknak meg kell ismerniük a műszaki dokumentáció történetét, különböző típusait és felhasználási módjait, nyelvezetét, struktúráját, az iparáganként változó formai és nyelvi követelményeket. Emellett a legelterjedtebb dokumentáláshoz használt jelölőnyelvek, tartalomkezelő szoftverek, szövegszerkesztők és grafikai megoldások is bemutatásra kerülnek. A hallgatók betekintést nyerhetnek továbbá a műszaki szakszövegírás munkafolyamataiba, a kapcsolattartás és információszerzés legpraktikusabb módszereibe, valamint a végfelhasználók visszajelzéseinek kezelésébe is.

A kurzus sikeres elvégzésével a hallgatók ismeret szereznek mind nyomtatott, mind digitális formában készült komplex, moduláris műszaki szakszöveg előállításához. A kapott technikai információk alapján strukturális és nyelvi változtatásokat tudnak eszközölni a szövegben a rendelkezésre álló eszközökkel az iparág tartalmi és formai követelményrendszerének figyelembevételével.

A tudományos írás tekintetében a kurzus kiemeli a legjobb gyakorlatokat, és felhívja a figyelmet a gyakori hibákra. A szerkesztéssel és lektorálással kapcsolatos feladatokat a globális tudományos közösség által használt legelterjedtebb publikációs stílus kézikönyveknek megfelelően írt konkrét példákon keresztül elemzi és tárgyalja. A kurzus tartalma nincs átfedésben a VIHIAV44 (Tudományos publikálás) kurzussal, hanem a műszaki kommunikáció szempontjából történő kibővítésként szolgál.

A félév során az iparág különböző szakértői meghívást kapnak, hogy további betekintést nyújtsanak a műszaki kommunikáció szabványosított eljárásaival kapcsolatban. A kurzus szinopszisa kilenc fő témakörből áll:

1.   A műszaki írás fejlődése és jelentősége (1. és 2. hét)
o   Mit nevezünk műszaki szakszövegírásnak?
o   Hogyan fejlődött a műszaki írás?

2.   Hogyan jön létre a műszaki szakszöveg? (3. és 4. hét)
o   Hogyan készül egy új dokumentum?
o   Melyek a technikai inputok típusai, és hogyan kell feldolgozni őket?
o   Mitől lesz egy dokumentáció „jó”?
o   Mi a műszaki írás munkafolyamata?

3.   Nyelvi és szerkezeti követelmények (5. és 6. hét)
o   Miben különbözik a műszaki írás stílusa más írásmódoktól?
o   Milyen nyelvi, stilisztikai és szerkezeti követelményei vannak a műszaki írásnak?

4.   Jelölőnyelvek és szövegszerkesztők (8. és 9. hét)
o   Az XML jelölőnyelv alapjai
o   Hogyan használjuk a DITA módszertant a tartalom létrehozásához?
o   Tartalomkezelő szoftverek alapjai
o   oXygen szerkesztő alapjai

5.   Grafikai megoldások, instructional design és tipográfia (10. hét)
o   Miért fontos a grafika és az animáció a műszaki szövegekben?
o   Milyen megoldások állnak rendelkezésre?
o   Melyek a nyomtatott szövegek legfontosabb tipográfiai szabályai?

6.   A végfelhasználói visszajelzések kezelése (11. hét)
o   Hogyan kérjünk és fogadjunk visszajelzést?
o   Hogyan lehet a visszajelzések alapján javítani a dokumentáció felhasználói élményét?

7.   Nyelvtan a tudományos publikálásban (12. hét)
o   Melyik igeidőt használjuk egy adott szövegkörnyezetben?
o   Hogyan hivatkozzunk korábbi tudományos munkákra?
o   Hogyan válasszuk ki a megfelelő írásjeleket a mondathoz?
o   Milyen hosszú legyen egy mondat?

8.   Gyakori hibák a tudományos publikációk írásakor (13. hét)
o   Melyek a leggyakoribb hibák, amelyek ronthatják a publikáció minőségét?

9.   Példák kamerakész és publikált cikkekre (14. hét)
o   Szerkesztés, lektorálás és az ezzel kapcsolatos feladatok.
o   Hogyan finomhangolhatunk egy cikket anélkül, hogy eltérnénk a sablontól?

9. A tantárgy oktatásának módja (előadás, gyakorlat, laboratórium) 2 óra (1 × 2 óra) előadás minden héten.

10. Követelmények •   1 zárthelyi dolgozat a 7. héten, mely az első 6 hét témaköreit fedi le.
•   1 beadandó házi dolgozat, melynek beadási határideje a 13. hét. A házi dolgozat keretein belül a hallgatónak műszaki dokumentációt (egy adott rendszer vagy szolgáltatás útmutatóját) kell készítenie, melyhez felhasználja a félév során tanultakat. A témák a 4. héten kerülnek kiosztásra.
•   A zárthelyi dolgozat 40%, míg a beadandó házi dolgozat 60% súlyozással kerül beszámításba a végső jegybe.
•   A tárgy sikeres elvégzéséhez mindkét követelményt legalább elégségesre (a megszerezhető pontok legalább 40%-nak elérésével) teljesíteni kell.

11. Pótlási lehetőségek A zárthelyi dolgozat pótolható a 15. héten. A házi dolgozat késedelmes beadási határideje a 15. hét.

12. Konzultációs lehetőségek Igény szerint a félév bármely pontján.

13. Jegyzet, tankönyv, felhasználható irodalom •   Alan S. Pringle and Sarah S. O'Keefe: Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content
•   Edmond H. Weiss: How to Write Usable User Documentation
•   JoAnn Hackos: Managing Your Documentation Projects
•   Michael J. Young: XML Step by Step
•   Robert Jacobson: Information Design
•   William Horton: Designing and Writing Online Documentation
•   William W. Lee and Diana L. Owens: Multimedia-Based Instructional Design
•   Kate L. Turabian: Manual for Writers of Research Papers, Theses, and Dissertations (Chicago Style for Students and Researchers)

14. A tantárgy elvégzéséhez átlagosan szükséges tanulmányi munka

Kontakt óra: 1 x 2 óra 14 héten keresztül	28
Félévközi készülés órákra	8
Felkészülés zárthelyire	8
Házi feladat elkészítése	16
Kijelölt írásos tananyag elsajátítása	0
Vizsgafelkészülés	0
Összesen	60

15. A tantárgy tematikáját kidolgozta

Név:	Beosztás:	Tanszék, Int.:
Dr. Kara Péter András	egyetemi tanársegéd	HIT