Mi a műszaki írás öt alapelve?

Hero Images/Hero Images / Getty Images

a műszaki írás a vállalat ügyfélszolgálati stratégiájának egyik legfontosabb eleme, és a műszaki íróknak öt alapelvet kell szem előtt tartaniuk ahhoz, hogy sikeresek legyenek: tartalom, céltudatosság, írási stílus, hozzáférhetőség és nyelvtan vagy használat. Az öt terület bármelyikének figyelmen kívül hagyása gyakran nem megfelelő dokumentumhoz és elégedetlenséghez vezet az ügyfél végén.

a minőségi tartalom a legfontosabb elv a műszaki írás során. Fontos szerepet játszik annak tudatosítása, hogy ki fogja elolvasni a felhasználói útmutatót, a Felhasználói útmutató által kitöltött tudáshiány és az útmutató kézbesítési módja.

a használati útmutató céljának ismerete fontos, különös tekintettel az útmutató közönségére. Az oktató szöveg írásakor fontos megérteni a felhasználó elfogultságát, csakúgy, mint az író kommunikációs felelősségének ismerete.

a dokumentum hozzáférhetősége a navigáció egyszerűségére utal. Ha a dokumentum PDF, akkor a linkeknek az olvasót a Tartalomjegyzékből a megfelelő szakaszokba kell vinniük. A táblázatok és illusztrációk listája is kötelező.

a helyes nyelvtannal való írás nyilvánvalónak tűnhet, de sok technikai háttérrel rendelkező ember küzd az írásbeli kommunikációval. A nyelvtannak és a használatnak világosnak és hibáktól mentesnek kell lennie.

az írási stílus az utolsó elv, amelyet a műszaki írók emlékeznek. A különböző típusú írásoknak különböző közönsége van, és minden közönségnek saját nyelvi igényei vannak, amelyeket az író tiszteletben tart a hang-és szóválasztással.

hirdetés

Vélemény, hozzászólás?

Az e-mail-címet nem tesszük közzé.