A műszaki szövegírás az egyik legnagyobb kihívást jelentő feladat, mivel az írónak a hi-tech információkat érthetően és világosan kell a közönség számára bemutatnia.
A technikai jellegű bejegyzések nem lehetnek túl bonyolultan érthetőek, vontatottak vagy nyelvtanilag helytelenek. És néha elég fárasztó feladat jó technikai útmutatókat találni, amelyek egyszerűen és világosan olvashatók.
Az Ön műszaki írása bármilyen formában készülhet, például
-
használati utasítás vagy felhasználói kézikönyv
-
Oktatási tanfolyami könyv
-
Termékleírások
-
Fehér könyvek
-
Termék kézikönyvek
-
Referencia kézikönyvek
-
Éves jelentések, és még sok más
Ebben a gyorsan fejlődő digitális korszakban a műszaki íróknak bizonyos stratégiákat kell alkalmazniuk az olvasók valódi elkötelezettségének eléréséhez. Valóban, ez egy hatalmas kihívás!
Ezért ebben a bejegyzésben néhány elképesztő tippet és trükköt adunk Önnek, hogy műszaki útmutatók írása során bevonja az olvasókat:
Ha műszaki írót szeretne alkalmazni, vagy műszaki író, aki távmunkát keres, nézze meg a Technikai írói állások elérhetőek a Jooble-on.
A műszaki író fő célkitűzései
1. Ismerje a közönséget
Elemezze a célközönséget, és ennek megfelelően a műszaki íróknak el kell dönteniük az írásuk stílusát, hangnemét, hosszát és formátumát.
A célközönség személyének ismerete nélkül előfordulhat, hogy túl egyszerű vagy túl bonyolult technikai bejegyzések írásával végzi. Márpedig ezt nem szeretnénk.
Meg kell próbálni megtalálni a tökéletes egyensúlyt a lényeglátó, hozzáértő és érthető információátadás között.
2. Olvashatóság
Az olvashatóság az egyik legfontosabb tényező a technikai olvasók bevonásához, mivel az olvashatósági pontszám dönti el, hogy a bejegyzésed valóban mennyire hozzáférhető. Az olvasóknak nem szabad, hogy nehezükre essen a technikai útmutatójában való navigálás, vagy a használt nyelvi szint megértése.
Az íróknak törekedniük kell arra, hogy felhasználóbarát nyelvezetet honosítsanak meg optimális stílusban és formátumban, amely informatív, mégis egyszerű.
3. Pontosság
A dokumentumban szereplő statisztikákat, tényeket és állításokat mindig ellenőriznie kell, és megbízható forrásokból származó bizonyítékokkal vagy tanulmányi jelentésekkel kell alátámasztani. Ellenkező esetben a közölt információk elveszíthetik hitelességüket és megbízhatóságukat a nyilvánosság előtt.
A fent említett célok elérése érdekében a műszaki írónak a következő stratégiákat kell kihasználnia:
-
A technikai információkat egyszerű, kristálytiszta módon kell közvetítenie, úgy, hogy azt még a nem műszaki érdeklődők is megértsék.
-
Olyan technikák és eszközök használata, amelyek csiszolják a nyújtott műszaki tartalmat.
-
A technikai javaslatokat, ötleteket, elképzeléseket, véleményeket és észrevételeket hatékonyan, stratégiai sorrendben helyezze el.
-
Használja a megfelelő hangzású szókincset pontos szerkezettel a jelentések, dokumentumok vagy prezentációk illusztrálására.
A 12 legjobb tipp, amit alkalmazhat, ha műszaki útmutatót ír, hogy lekösse az olvasóit.
1. Elemezze a célközönség szakértelmét
A műszaki útmutatóknak informatívnak és lényeglátónak kell lenniük. Az ilyen tartalom megírásakor az írónak elemeznie kell, hogy a közönség mennyit tud már a témához kapcsolódó technikai fogalmakról.
Nem kell olyan témákat értelmezni, amelyekben a közönség már jól járatos. Ugyanígy nem logikus kihagyni olyan fogalmakat, amelyekről a közönsége esetleg nem rendelkezik alapvető ismeretekkel. Mindkét esetben a közönsége valószínűleg elveszíti az érdeklődését, vagy túl bonyolultnak, illetve szükségtelenül hosszadalmasnak találja a technikai útmutatóját.
A kulcs itt az, hogy elemezze közönsége alapvető ismereteit és képességeit, majd olyan információkkal lássa el őket, amelyek szilárd alapot teremtenek a témával kapcsolatban, és egyúttal tanulságosak is.
2. Mélyreható kutatás
A technikai tartalom írása átfogó kutatást és pontos, korrekt statisztikákkal vagy tényekkel alátámasztott információdarabot igényel. Ez az, ami súlyt és értéket ad a műszaki tartalomnak; ezért ez a legfontosabb tényező az olvasók bevonásához.
Végezze el a kontextus és a technikai információk részletes elemzését, például:
-
A téma minden technikai vonatkozásával kapcsolatos információk gyűjtése, beleértve a tárgykör, a jellemzők, a tervezési folyamat, a specifikációk, a jogi keretek stb.
-
Jogi szerződések és azok követelményeinek tanulmányozása. A műszaki tartalomnak meg kell felelnie az alkalmazandó szabályozási előírásoknak. Ezért ügyeljen arra, hogy lépést tartson a jogi követelményekkel.
-
Elemezze a célközönséget, és szabja a tartalmat a felhasználók célcsoportjának megértése és követelményei szerint. Ez különböző szempontokat foglal magában, mint például a grafika, a nyelvi szint, a kimeneti média típusa, az olvashatóság, a bonyolultsági szint stb.
3. A megjelenítés szerkezete
A műszaki ismeretek útmutatók vagy kézikönyvek formájában történő átadásakor a szerkezet és a formátum alapvető szerepet játszik.
A műszaki útmutatókat, mivel kissé összetett a megértésük; ezért nem szeretne még bonyolultabb szerkezetet beépíteni a szerkezetbe. Az ilyen tartalmakkal való elköteleződés kialakítása nehézzé válik.
Ahhoz, hogy értéket nyújtson a közönségének, az írónak meg kell fontolnia, hogyan strukturálja a tartalmat úgy, ahogyan a közönség szeretne vele foglalkozni.
4. Vizuális elemek és grafikák
A technikával kapcsolatos, vizuálisan vonzó, ugyanakkor informatív képek használata nemcsak taktikailag töri meg a tartalmat, hanem az olvasókat is bevonja.
A mai olvasók figyelmi ideje rövidnek tűnik. Ezért a képekkel ellátott műszaki útmutató megkönnyíti a tartalom navigálását, és gördülékenyebbé teszi, valamint segít megtörni a hosszú szövegblokkokat.
Hasonlóképpen, ne vigye túlzásba a túl sok képet, mivel az háttérbe szoríthatja a tényleges technikai információkat. Próbáljon meg egyensúlyt teremteni a szöveg és a vizuális megjelenítés között.
5. A példák elengedhetetlenek
A példák képesek az összetett témákat könnyebben érthetővé tenni. Világítson meg egy valós idejű forgatókönyvet, amely rezonál a képen látható témára, hogy a közönség jobban megértse azt. A műszaki írók akár képeket is használhatnak példaként, majd elmagyarázhatják azt.
6. Hangoztassa helyesen
Gyakran előfordul, hogy egy technikai útmutató semleges hangnemben, világiasan hangzik, pedig nem kellene, hogy így legyen. A műszaki útmutatónak saját hanggal kell rendelkeznie, és ennek egyik legjobb módja az első személyű perspektíva használata.
Ha egyes szám első személyben ír, ügyeljen arra, hogy továbbra is hiteles és professzionális megközelítést alkalmazzon.
7. Használjon végig egyszerű nyelvezetet
A műszaki írásnak nem szabad bonyolultnak lennie, csak azért, mert hi-tech témákat tárgyal. Amikor műszaki fogalmakat, folyamatokat vagy módszereket próbál meghatározni, próbáljon lépést tartani a technikai kreativitással anélkül, hogy túlbonyolítaná a dolgokat.
A katasztrofális írás egyik leggyakoribb bűnössége, hogy nem veszi figyelembe azt a tényt, hogy az olvasók esetleg nem jártasak bizonyos fogalmakban. Ezzel együtt nagyon valószínű, hogy a közönséged zavarodottnak, nem megfelelőnek és kevésbé bevontnak fogja érezni magát.
Az egyszerű technikai angol (STE) szabványok javítják a dokumentum fordíthatóságát és olvashatóságát.
Próbáljon meg műszaki útmutatót írni a következő szabályok alkalmazásával:
-
Egyszerű mondatszerkezet
-
Aktív hang
-
Következetes kifejezések
-
Egyszerű igeidők
Más szóval, próbáld meg egyszerűen és röviden megfogalmazni.
8. Tisztázza a horgot
Mindjárt a technikai útmutató elején határozza meg a tartalom kampóját, vagyis azt, hogy az olvasók mit fognak megtudni az útmutatóból. Gyorsan vázolja fel a technikai tartalmat, és magyarázza el az összes olyan területet, amelyet a cikke le fog fedni, így az olvasók tudni fogják, mire számíthatnak.
Ezzel biztosíthatja, hogy olvasói elégedettnek és teljesnek érezzék magukat, ha végül elolvassák a teljes útmutatót. Senki sem akar egy egész tartalmi blokkot elolvasni, csak hogy a végén rájöjjön, hogy nem az az információ, amit keresett.
9. Az elrendezés alapvető fontosságú
Az elrendezés az egyik hatékony módja annak, hogy műszaki tartalmait vonzóbbá és olvashatóbbá tegye, miközben a kulcsfontosságú területekre összpontosít.
Használja stratégiailag az oldaltöréseket, a felsorolásos pontokat, a számozott listákat, a félkövérrel szedett kulcsszavakat és a táblázatokat, hogy kiemelje a lényeges pontokat, és felhívja a figyelmet a megfelelő részekre.
10. Kerülje az adott időszakra való hivatkozást.
Annak érdekében, hogy műszaki tartalma hosszú ideig érvényes maradjon, ügyeljen arra, hogy ne hivatkozzon egy adott évre, például "2021-ben" vagy "idén". Az ilyen kifejezések használata egy adott időszakra korlátozza és datálja a tartalmát, és csökkenti annak hosszú távú érvényességét.
Bizonyítsa be tartalmát a jövőre nézve azzal, hogy nem használ időhöz kötött hivatkozást; inkább próbálja általánossá tenni.
11. Legyen szellemes
Még ha technikai tartalomról van is szó, próbáljon meg némi humorral vagy szellemességgel könnyedebbé tenni. Ez az egyik legegyszerűbb és leghatékonyabb módja annak, hogy horogra akassza a közönségét.
12. Tekintse át a technikai dokumentumot
Mindig okos lépés, ha a műszaki dokumentációját egyszer átnézi a szakterület szakértője (kkv), hogy hitelesítse a tartalmát. Ez nem csak felbecsülhetetlen értékű betekintést nyújt Önnek, hanem nyelvtani hibáktól is mentessé teszi azt.
Következtetés
Ezzel befejezzük a kreatív posztunkat arról, hogyan vonzzuk be olvasóinkat egy műszaki útmutató megírásakor. Végül, de nem utolsósorban; győződjön meg róla, hogy állításait és tényeit mindig a megfelelő információforrással támasztja alá, például statisztikákkal, jelentésekkel, kutatási dokumentumokkal stb.
Továbbá, miután elkészült, vizsgálja felül műszaki dokumentumát, és győződjön meg róla, hogy az világos, pontos és naprakész. Ez minden!