technické psaní je praxe zpracování dokumentů a vizuálů, verbálních informací a ukázek výukových materiálů. Účelem technického psaní je poskytnout materiál, který vysvětluje proces nebo usnadňuje pochopení komplexního konceptu pro konkrétní publikum. Prostřednictvím efektivního a efektivního technického psaní bude spisovatel schopen vysvětlit a pomoci čtenáři, jak porozumět informacím a plnit konkrétní úkoly. Existuje pět univerzálních etických principů technického psaní. Principy jsou kvalitní obsah, publikum a účel, Přístupnost, gramatika, a styl psaní.
kvalitní obsah
kvalitní obsah je subjektivní. MATC definice vysoce kvalitního obsahu je produkt, který splňuje standardy klienta nebo jde nad rámec původního rozsahu projektu. Chcete-li vytvořit vysoce kvalitní projekt, musíte psát s ohledem na zamýšlené publikum. Spisovatel musí prozkoumat další znalosti potřebné před dokončením dokumentu nebo materiálu. Spisovatel potřebuje vědět, jaký formát nebo platforma bude použita k reprezentaci informací. Spisovatel musí určit konkrétní informace, které sahají od poznání, jaké jsou lhůty, až po poznání, proč je třeba tyto informace napsat.
publikum a účel
spisovatel musí pochopit účel i publikum, aby vytvořil vynikající technický kus. Publikum technického psaní se liší podle odvětví a konkrétního klienta. Například, publikum zprávy kola by bylo výrobou produktů, kteří nás najali jako spisovatele. Publikem modulu školení eLearning může být poskytovatel banky nebo hypotéky, který potřebuje školení o dodržování předpisů. Spisovatel musí vědět, kolik čtenáři budou vědět a jaké povinnosti spisovatel je povinen splnit, pokud jde o komunikaci se čtenáři.
Přístupnost
je nezbytné, aby publikum mělo snadný přístup k informacím, které spisovatel vytvořil. Přístupnost zahrnuje vše, co je v dokumentu, jako jsou záhlaví a zápatí, nebo na modulech iLearn počítače, které zlepšují formátování přístupnosti tak, aby bylo univerzálnější a jasnější. Technický spisovatel musí přijít na nejlepší metodu, která čtenářům pomůže orientovat se v dokumentaci s notacemi z bibliografie na čísla stránek do obsahu. Spisovatel mohl dokonce přidat vizuální prvky, jako jsou grafy a obrázky, k dalšímu vysvětlení informací.
gramatika
psaní jasné, stručné a přímočaré se správným používáním gramatiky je zásadní při psaní jakéhokoli technického díla. Spisovatel musí také korigovat a upravovat jakýkoli technický kus, který je napsán, aby opravil případné chyby nebo nesrovnalosti s gramatikou, stylem a rozvržením. Technický spisovatel by měl vždy psát v přítomném čase, pokud klient neuvede své preference jinak. Čtenář technického díla by měl dělat přesně to, co dáváte pokyny. Spisovatel by měl vždy psát v jednoduchých větách, které obsahují genderově neutrální podstatná jména. Jednoduché věty pomáhají čtenářům jasně a efektivně porozumět úkolům, které musí splnit, aby splnili své cíle.
styl psaní
styl psaní se liší pro každý technický kus, protože silně závisí na tom, kdo je publikum a na scénáři, pro který je technický kus napsán. Tón technického psaní je nezbytný, protože pomáhá čtenáři pochopit, jaký tón je nutný k dokončení úkolu. Výběr slov je také nezbytnou součástí stylu, který pomáhá zajistit potřeby publika, protože se připojuje zpět k tomu, kdo je vaše publikum. Při odkazování na části informací nebo webových stránek je nezbytné poskytnout jasné a viditelné způsoby přístupu k informacím pomocí nástrojů, jako jsou obrázky a tabulky.
další technické tipy pro psaní
proveďte další výzkum a dozvíte se více
znát holé minimum nemusí získat nejlepší technický kus, který pomůže publiku porozumět informacím. Mohlo by existovat mnoho terminologie, které autor i čtenář nemusí rozumět. Obecně platí, že pokud jako čtenář nerozumíte pojmu nebo pojmu, definujte jej. V pozdějších recenzích lze vždy snížit příliš mnoho informací. Tyto informace by měly být prozkoumány, aby bylo možné pochopit, jak to funguje s tím, co spisovatel píše jako celek. Výzkum malého otce a zjistit, jaké další informace by mohly být použity k posílení technické kus je psán.
Staňte se publikem a podceňujte publikum
Vžijte se do bot publika. Můžete jasně pochopit a řídit se pokyny nebo informacemi, které jste napsali pro publikum? Pokud ano, můžete poskytnout více informací, pokud si myslíte, že potřebuje trochu více pomoci. Pokud ne, musíte najít části, které nejsou jasné, a najít způsob, jak správně poskytnout informace. Velkým problémem, který často mají techničtí spisovatelé, je to, že přeceňují znalosti svého publika. Publikum může být více lidí na různých úrovních znalostí. Je naprosto přijatelné stručně poskytnout informace, které lze předpokládat nebo již uvést jako osvěžovač pro publikum.
požádejte o druhý a třetí názor a Peer Review
techničtí spisovatelé jsou vynalézaví. Největším zdrojem, který máte, jsou odborníci na předmět. Nezapomeňte se zeptat svého malého a středního podniku, pokud vidí nějaké mezery nebo chyby ve znalostech. Spisovatelé zkontrolovat se svými klienty, aby zjistili, zda existují nějaké mezery ve znalostech nebo chyby, které spisovatel mohl přehlédnout. Mít nadřízeného nebo kolegu, aby se podíval a vydal názor, by také mohlo pomoci vylepšit technický kus. Peer review je, když se skupina lidí setká, aby si přečetla, komentovala a doporučila zlepšení vzájemné práce. Více slepých míst se odkryje, když více lidí zkontroluje dokument, což zajišťuje přesné a stručné informace.
techničtí spisovatelé se učí nové informace pro každý Projekt, na kterém pracují. Spisovatelé lépe pochopí, co klienti potřebují, protože začínají pod úrovní znalostí svých čtenářů před veškerým výzkumem a diskusemi s odborníky na předmět. To se stává velkým přínosem pro společnosti, protože méně předpokladů se otevírá pro efektivnější školení. Kombinace spisovatelů, kteří se učí materiál a tyto etické principy technických standardů psaní vedou k sebevědomějším a efektivnějším zaměstnancům.