Dit maak nie saak hoe vindingryk 'n uitvinder, programmeerder of rasionaliseerder is nie, soms kan sy skeppings eenvoudig nie vir die doel gebruik word nie. Die rede hiervoor is die verkeerd opgestelde handleiding of die volledige afwesigheid daarvan. Maar selfs vindingryke uitvinders skryf soms sulke instruksies dat, behalwe nou spesialiste, niemand hierdie vraestelle kan lees nie. Hoe kan u dan so 'n nodige dokument opstel?
Dit is nodig
- - honderd persent kennis van die toestel of sagteware produk waarvoor die handleiding geskryf word;
- - kennis op die gebied van taalkunde;
- - skryfvaardighede.
Instruksies
Stap 1
'N Gebruikershandleiding of, met ander woorde, 'n bedieningshandleiding is 'n dokument wat ontwerp is om hulp te verleen in die gebruik van 'n sekere stelsel aan sy gebruikers. Om 'n gebruikershandleiding saam te stel, moet u die beskrewe stelsel honderd persent ken, maar kyk daarna deur die oë van 'n onkundige student. Gestel 'n gebruikershandleiding is geskryf vir 'n sagtewareprogram wat nog geen analoë het nie. Stel jou voor dat dit die eerste keer is dat jy hierdie program gebruik. Waar begin jy? Wat is die eerste ding om te weet? Organiseer hierdie kennis in kategorieë van belang.
Stap 2
Deur al die inligting rakende u skepping in groepe te verdeel, het u 'n plan opgestel vir die skryf van 'n gebruikershandleiding. Begin om die werk in u program van voor af te beskryf, en laat die laaste moeilikste besonderhede oor, soos die herprogrammering van funksies of die hantering van kritieke foute. In hierdie stadium moet u die inhoud van die gebruikershandleiding gereed hê - een van die vereiste dele van hierdie dokument.
Stap 3
As die handleiding wat u maak, bedoel is vir gebruik in 'n groot onderneming, moet u let op die korporatiewe standaarde wat daar aanvaar word. Byvoorbeeld, in baie Russiese maatskappye word gebruikershandleidings nie aanvaar sonder illustratiewe ondersteuning nie, met ander woorde foto's wat verduidelik wat daar staan. Benewens die inhoud, moet die gebruikershandleiding ook ander verpligte dele bevat: - 'n aantekening, dit wil sê 'n uiteensetting van die algemene doelstellings van die handleiding en die beskrywe produk; - 'n inleiding waarin die dokumente met betrekking tot die gebruikershandleiding beskryf word en hoe die handleiding te gebruik; - gedeeltes wat die gebruik van die produk in verskillende stadiums van die gebruik daarvan uiteensit, byvoorbeeld eerste stappe, herstel of instandhouding; - 'n gedeelte van die vrae wat gereeld gevra word en antwoorde daarop;
Stap 4
Gewoonlik is 'n tegniese skrywer betrokke by die skepping van 'n gebruikershandleiding - 'n persoon wat al die nodige kennis het in die taal en die produk wat beskryf word. As tegniese skrywer sonder opleiding is daar 'n paar reëls wat u in ag moet neem. In die eerste plek moet u nie spesiale terme misbruik wat nie vir 'n gewone gebruiker verstaanbaar is nie. Tweedens moet elke term wat gebruik word, gedetailleerd en verduidelik word. Derdens moet u so duidelik en bondig as moontlik skryf. Ten slotte moet 'n tegniese skrywer in staat wees om na hul eie teks deur die oë van 'n gewone gebruiker te kyk om die tekortkominge van hul eie teks te sien.
Stap 5
Dit is goed om die voltooide teks van die gebruikershandleiding in die praktyk te toets deur dit aan iemand aan te bied wat niks met die beskrywe produk te doen gehad het nie. Deur gesamentlike pogings is dit moontlik om al die tekortkominge en slaggate van die dokument uit die weg te ruim.
