Technical Documentation Copy and Paste Kit

Popis

Nie, táto súprava za vás nenapíše vašu ďalšiu používateľskú príručku ani váš ďalší online systém pomoci. Táto súprava vám však pomôže napísať technickú dokumentáciu s menšou námahou a pomôže vám vytvárať užívateľsky prívetivé dokumenty vysokej kvality.

Súprava vám poskytuje presne tie veci, ktoré váš textový editor, pomocný nástroj na tvorbu obsahu alebo systém na správu obsahu neposkytuje: know-how a návod na vytvorenie vysokokvalitnej používateľskej pomoci.

Na rozdiel od mnohých učebníc technického písania však súprava neposkytuje zdĺhavé teoretické rozpracovania. Poskytuje praktické odporúčania a príklady, ktoré si ľahko zapamätáte a prispôsobíte vlastnej práci.

Súprava pokrýva:

* vizuálny dizajn (rozloženie) vašich dokumentov

* štruktúra vašich dokumentov

* ako napísať jednoduché pokyny, ktorým bude rozumieť každý používateľ

Nemusíte byť dizajnér, aby ste implementovali odporúčania pre dizajn, a nemusíte byť lingvista, aby ste pochopili pravidlá písania. Všetky odporúčania prichádzajú s pútavými príkladmi.

Sada je napísaná jednoduchou angličtinou, ktorej ľahko porozumiete, aj keď hovoríte po anglicky ako druhým jazykom. Takmer všetky pravidlá sú univerzálne, takže sadu môžete použiť aj v prípade, že píšete v iných jazykoch ako v angličtine.

V edícii Plus súpravy môžete vy a váš tím pridať vlastné konvencie a predpisy špecifické pre vašu spoločnosť. Získanie profesionálneho, no prispôsobeného interaktívneho sprievodcu štýlom písania nebolo nikdy jednoduchšie. Môžete slobodne určiť, kto môže upravovať pravidlá: len vy, iba vybraní členovia tímu alebo všetci.