Una dintre principalele activități ale unui scriitor tehnic este de a scrie documentația tehnică pentru software-ul.
Specii o astfel de documentație mult: este caietul de sarcini și metode de testare, precum și programe, texte și manuale și tot felul de ajutor pentru utilizator. Pentru utilizarea convenabilă a acestor documente aceasta trebuie să fie scurt în volum, conținut relevant, plin de semnificații.
Există două modalități de a scrie documentația tehnică.
1. O metodă pentru scrierea documentației tehnice pentru experți.
1. Determinarea informațiilor necesare. Această documentație va fi utilizat de către specialiști (programatori, designeri de interfață), și, prin urmare, ar trebui să conțină informații precise cu privire la program. Acestea pot fi, de asemenea, incluse:
- fișierele principale de aplicație, care sunt create de dezvoltatori, instrumente de baze de date alte programe
- subrutine și funcții cu explicarea scopului fiecăreia dintre ele,
- constante și variabile de produs care indică metoda de utilizare a acestora,
- structura unificată a software-ului.
2. Sortarea Documente privind principiul includerii în codul programului și crearea unor documente separate. includerea maximă a documentației în codul de program mai ușor de actualizat și software-ul de sprijin.
3. Instrumentul de documentare. Acesta este determinat de limba în care pentru a crea software-ul și tipul de documente necesare.
Metoda 2: Scrierea documentatiei tehnice pentru utilizatorii finali.
1. Baza pentru documentația. suport documentar este necesar pentru orice produs software, pentru a arăta utilizatorilor modul de aplicare a acesteia și de a oferi suport tehnic. De asemenea, în astfel de documente sunt specificate condițiile legale.
2. Identificarea publicului țintă. Este rareori o gamă largă de utilizatori sunt specialiști într-un anumit domeniu. Pentru a izola publicul țintă:
- specifica intervalul de posturi de angajați care vor lucra cu aplicația software,
- Încearcă să se întâlnească cu acești oameni și pentru a crea propria lor idee despre nivelul de pregătire a acestora,
- în principal, în setul de program scris tehnic răspuns la întrebarea care poate da produsul unui anumit utilizator.
3. Selectați un format feed de date pentru scrierea documentatiei tehnice. De obicei, sau ghid de referință sau ghidul de folosire.
4. Selectați forma de documente (diferite referințe, fișiere PDF, manuale tipărite, etc.).
5. Selectați un instrument de documentare user-friendly (software).