Technical Documentation Copy and Paste Kit

Deskrizzjoni

Le, dan il-kit mhux se jikteb il-manwal tal-utent li jmiss tiegħek jew is-sistema ta' għajnuna onlajn li jmiss għalik. Madankollu, dan il-kit jgħinek tikteb id-dokumentazzjoni teknika tiegħek b'inqas sforz, u tgħinek tipproduċi dokumenti ta 'kwalità għolja faċli għall-utent.

Il-kit jagħtik eżattament dawk l-affarijiet li l-editur tat-test, l-għodda ta’ għajnuna għall-awtur jew is-sistema ta’ ġestjoni tal-kontenut tiegħek ma jipprovdux: l-għarfien u l-gwida biex toħloq assistenza għall-utent ta’ kwalità għolja.

Madankollu, b'differenza minn ħafna kotba dwar il-kitba teknika, il-kit ma jagħtix elaborazzjonijiet teoretiċi twal. Jagħti rakkomandazzjonijiet prattiċi u eżempji li faċilment tista' tiftakar u tadatta għax-xogħol tiegħek stess.

Il-kit ikopri:

* id-disinn viżwali (it-tqassim) tad-dokumenti tiegħek

* l-istruttura tad-dokumenti tiegħek

* kif tikteb struzzjonijiet sempliċi li kull utent jifhem

M'għandekx għalfejn tkun disinjatur biex timplimenta r-rakkomandazzjonijiet tad-disinn, u m'għandekx għalfejn tkun lingwista biex tifhem ir-regoli tal-kitba. Ir-rakkomandazzjonijiet kollha jiġu b'eżempji li jolqtu.

Il-kit huwa miktub b'Ingliż sempliċi u sempliċi li tista' tifhem faċilment anki jekk titkellem bl-Ingliż bħala t-tieni lingwa. Kważi r-regoli kollha huma universali, għalhekk tista 'tuża wkoll il-kit jekk tikteb b'lingwi oħra minbarra l-Ingliż.

Fl-Edizzjoni Plus tal-kit, int u t-tim tiegħek tista' żżid il-konvenzjonijiet u r-regolamenti speċifiċi għall-kumpanija tiegħek stess. Li tikseb gwida tal-istil tal-kitba interattiva professjonali iżda personalizzata qatt ma kienet daqshekk faċli. Inti liberu li tikkontrolla min jista' jeditja r-regoli: int biss, membri tat-tim magħżula biss, jew kulħadd.