Jaké jsou pět základních principů technického psaní?

Hero Images/Hero Images / Getty Images

technické psaní je jedním z nejdůležitějších prvků strategie zákaznické podpory společnosti a existuje pět principů, které musí mít techničtí spisovatelé na paměti, aby byli úspěšní: obsah, povědomí o účelu, styl psaní, přístupnost a gramatika nebo použití. Nepozornost na některou z těchto pěti oblastí často vede k nestandardnímu dokumentu a nespokojenosti na konci klienta.

kvalitní obsah je nejdůležitějším principem, pokud jde o technické psaní. Důležitou roli hraje povědomí o tom, kdo si přečte uživatelskou příručku, mezeru ve znalostech, kterou uživatelská příručka vyplňuje, a způsob doručení průvodce.

Znalost účelu uživatelské příručky je důležitá, zejména s ohledem na publikum průvodce. Pochopení předsudků uživatele je důležité při psaní instruktážního textu, stejně jako znalost odpovědnosti spisovatele v komunikaci.

Přístupnost dokumentu odkazuje na snadnou navigaci. Pokud je dokument PDF, odkazy by měly čtenáře přenést z obsahu do příslušných sekcí. Také seznam tabulek a ilustrací je nutností.

psaní se správnou gramatikou se může zdát zřejmé, ale mnoho lidí s technickým zázemím bojuje s písemnou komunikací. Gramatika a použití musí být jasné a bez chyb.

styl psaní je konečný princip pro technické spisovatele pamatovat. Různé typy psaní mají různé publikum a každé publikum má své vlastní jazykové potřeby, které spisovatel respektuje výběrem tónu a slova.

reklama

Napsat komentář

Vaše e-mailová adresa nebude zveřejněna.