základní principy technického psaní

tu a tam musíme přehodnotit základní principy technického psaní. Od roku 1997, kdy jsme začali, zůstávají základní principy technického psaní stejné, i když se mění způsoby komunikace.

účel a publikum

před zahájením jakéhokoli nového projektu psaní musí technický spisovatel analyzovat účel dokumentu a identifikovat jeho zamýšlené publikum. Spisovatel se musí zeptat:

• kdo bude číst dokumentaci?
• jaké jsou jejich předsudky?
• jaké povinnosti mám při sdělování informací publiku?

průvodce stylem

techničtí spisovatelé často používají průvodce stylem společnosti, pokud je k dispozici, aby zajistili, že jejich dokumentace má strukturovaný vzor. Příručka stylů (například AP Stylebook) poskytuje pokyny pro vzhled dokumentu, Jazyk, který používá, a jak jsou uspořádány nápady. Tato organizace poskytuje kontinuitu dokumentu nebo sérii dokumentů, takže publikum může snadno pochopit informace. Například technický spisovatel může dokumentovat proces chronologicky, jak je diktováno v průvodci stylem. Bez této struktury by čtenář byl zmatený a nemohl by tento proces sledovat. Průvodce stylem činí psaní konzistentnějším a čitelnějším.

styl psaní

techničtí spisovatelé mění svůj styl psaní v závislosti na publiku a situaci, o které píší. Pokud píší technickou dokumentaci, měl by být styl formální, bez emocí, které získáte při tvůrčím psaní. Pokud píšou e-mail jednomu z vedoucích manažerů zapojených do projektu, pak by jejich styl byl více konverzační.

přístup k informacím

Přístupnost je, jak snadno mohou být informace v dokumentu získány zamýšleným publikem. Technický dokument obsahuje prvky, jako je obsah, záhlaví, zápatí a čísla stránek, které pomáhají čtenářům při navigaci v dokumentu a hledání potřebných informací. Technický dokument také dodržuje specifickou strukturu nadpisů a podkapitol, aby rozdělil informace do příslušných sekcí, ke kterým má čtenář snadný přístup.

to jsou jen některé z aspektů, kterými se zabýváme jako techničtí spisovatelé. Pokud si chcete vylepšit své vlastní technické dovednosti psaní, zvažte náš technický psací Workshop. Může být přizpůsoben tak, aby vyhovoval potřebám 1 osoby nebo 20 lidí!

pokud nechcete dokument psát sami a potřebujete pomoc zkušeného technického spisovatele, podívejte se na naši stránku služeb.

jsme tu, abychom vám pomohli. Kontaktujte nás ještě dnes!