Tölvumál - 01.05.1986, Page 13

- að byrja á byrjuninni!
- snyrtileg uppsetning, sem gefur bðkinni greinilega
heildarmynd
- stuttar og hnitmiðaðar setningar
- stuttar málsgreinar
- að forðast tæknimál og skammstafanir
- að endurtekningar eiga rétt á sér í handbokum
- að gefa dæmi með skýringartexta um raunhæfa
vinnslu
Sá, sem skrifar handbðk, þarf að sjálfsögðu að þekkja
hvernig forritið vinnur. ffiskilegast er að hann
fylgist með þegar forritið er hannað, þannig að
handbðk og forrit séu tilbúin samtímis. Hann þarf
því að vinna hratt, en skipulega, og fá gagnrýni á
handritið á öllum vinnslustigum þess.
1 einum af fyrstu köflum handbókar má gjarnan vera
lausleg kynning á helstu atriðum í stýrikerfi tölv-
unnar, svo sem skráarnöfn, hvernig tekin eru afrit og
nokkur fleiri undirstöðuatriði.
Þar á eftir er nauðsynlegt að skapa, notandanum
öryggistilfinningu með því að kynna honum á einfaldan
hátt hvernig komast má inn og út úr forritinu. Síðan
er skrifað um hvern þátt vinnslunnar fyrir sig i
sérstökum köflum. Þeir mega gjarnan hafa undirkafla
til aðgreiningar á aðalatriðum. Þar er farið nákvæm-
lega yfir hvert einstakt atriði £ vinnslunni og sýnd
dæmi.
Nauðsynlegt er að hafa kafla með samandregnu efni,
sem notandi getur flett upp i þegar hann er orðinn
nokkuð öruggur £ notkun forritsins. Hann er ágætt að
hafa aftast eða aftarlega I bókinni til þess að hann
eða þeir rugli ekki byrjendur. Handbðkin er þá ekki
lengur lesin I smáatriðum, heldur notuð sem upp-
flettibók.
Atriðisorðaskrár (Index) eru mjög nytsamlegar. 1
þeim þurfa að koma fram blaðsiðutöl fyrir flest þau
atriði, sem minnst er á í handbðkinni, þar með talin
dæmi. Ef þessi atriði eru höfð í huga gæti handbðkin
13