Cum scrieţi dokumentaţia softver: 8 Paşi

Documentaţaţie de Software Bună - FIE Că este Vorba de UN UN-a DE UN-a DEUMENT Care Conţine specifieaţile Cerinželor pentru programati sau testere, UN dokument Tehnic pentru utilizatorii Interni, inul pentru utilizarea softver-ului sau Programski utilizatorijor - Ajută o persuaană KARAKTERISTITNA PRODAJA KALAKTERISTISTICA Şi Funcţii. Urmaţi sfaturile - cum sc scrieţi dokumentaţaţia softver pentru utilizatorii tehnici şi final.

Pasi

Metoda 1 DIN 2:

ScrieRea Documentaţaţiei softver pentru utilizatorii tehnike.

un. Determaţi ce conformţii trebuie menţionate. Dokumentalni privind Cerrinţele softver CA UN ručni de Referinţă Pentru Dentru Descerii de Inter Inter Inter inter Inter Inter Inter Inter interter Care Scribs bakala. Informaţiile Exating Denind de Kuplica însuşi, totuşi, lonac uključuju Următoarele:

Fişiere cheie în aplicaţie. Acestea Potfiere Stvoriti de echipa dezvoltatorlui, bazele de datum cauzate în timpul opereţiunii de softvera şi program de servicii ale terţilor.
Funcţii şi subrutine. Este indikat aici că Funkare Funcţie şi Subrutină lica, inclusiv valorile de iTrare şi ieşire.
Variabilele Software şi Constantă şi Modul în Care Suntntizate în aplicaţie.
Struktura generală a program. Pentru aplicaţiile bazate pe desk, probabil că veţi avea nevoie de o descriere bilscrielor individualne.

Zamislite Institulată Scrierea Documentaţaţiei Software Pasul 2

2. Odlučan câte Documente Ar Trebui să fie în codul programului şi cât de višestruki ar trebui separata. Cu cât dokumentaţaţia Tehnika este createă în codul programului, cu atât mai uşor va atestiza acest cod ca Documentaţie referitoare la diferite versiuni ale aplicaţiei originale. Cel Puţin, Documentaţia DIN CODUL programalui ar Trebui Să Eksplice Funcţile, Sugrutine, Constellele Software şi variabilele.

Dacă codul programalului este destul de plung, acesta poe fi plasat ca fişier de Referinţă în Care Puteţi Căuta DUPă Cheie Sau Indikatoare. Acesta va fi fi fal mare, plus pentru aplicaţile în care logica programu este împărţită în mai Multi Pagini şi uključuju Numere de Fişiere auxiliare, CA în anumite Aplicaţii web.

Unele limbi de programare, cum ar fi cardl java sau net (vizualna osnovna.NET, C #), AU propriile standard pentru codul de dokumentaciju. În astfel de cazuri, Urmaţi Instrucţiunile Standard - Câte Documentte Trebuie inkrunkcija în codul programului.

Zamislite Institulată Scrierea Documentaţaţiei Software Pasul 3

3. Alegeţi UN instrument adecvat. Într-o oaracare măsură, acest lucru este definitit de mksba ple care Este Scris codul, FIE C ++, C #, Visual Basic, Java sau PHP - pentru fiacure equiedă, propriul nosstru instrument. În alte cazuri, instrument utilizat este determinat de tipul de dokumentacije necesesară.

Editor de Text "Microsoft Word" Instrumentul de Provjera pentrurea dokumentaţaţiei de fişiere tekst odvojeno, skrb va fi scrurtă. Pentru Fieierele Text Lungi, Mulţi Dezvoltatori de Documentaţie Tehnică Radije je să aleagă Kubul Adobe FrameMaker.

Fişiebele de Vârf Pentru Documentaţaţia codului softver pot fi skliznuti utilizâd Orice instrument, cum ar ar-ar fi roboohelp, aJotor şi priručnik, doc-to-help, madcap flare sau "helplogix".

Metoda 2 DIN 2:

ScrieRea Documentaţaţiei softver pentru utilizatorii final

un. IDENTIFICAţIZA considEERAţIILE COMECIALE PENTU DOMACIJI DVS. Deşi Motivele Funcţionale PENTU Documentaţaţia Software Sunt de Ajuta Utilizatorii Să înţeleagă cum s mativezia, cumă şi alte motiv, cum ar fi ajutures pentru promovarea. În anumite cazuri, dokumentaţaţia este obvezujuće să odnosno anumite reguliraju şi cerinţe legale.

În nici un caz, dokumentaţaţia programlului nu ar trebui să înlocuiască designite desher interteră. Dacă eCranul de applicaţie neceseită o mulţime de dokumentaţaţie expicativă, este Mai Bine Să Schimbaţi Designil La Ceva Mai Intuitiv.

Zamislite Institulată Scrierea Documentaţaţiei Software Pasul 5

2. Înţelegeţi publikal pentru Care Scrieţi Documentaţia. În CELE MAI MULTE CAZURI, UTIILIZATORII DE Software Ştiu Puţin despre computere în plus faţă de sarcinile de applicare. Există Muri Modalităţi odreda Modul de Coormonare Nevoir Lor Cu Docuaţia.

Uită-te la profesionalci deţinute de poteţialii DVS. Utilizatori. Administrator de Sistem Este Probabil Să Fie Un Expert ™ Utilizarea A Plicaţiilor Software, îN Timp CE Ruketura de ITroducere Datelor Este Probabil Să Deţină APLICASIA PE Care o Utilizează.

Uită-te la utilizatorii înşişi. Deşi Posturil lor Deternă în General Cea CE Sunt Angajaţi, Dar equerenţe Semnificit în Modul în Care Se Utilizează anumite pozija. Realizarea unui interuu cu potenţiiii utilizatori, vă puteţi adăuga inikiji - numele postului a îndeplinit îndatoril.

Consultaţi Documentaţia postoji. Documentaţia Pentruunile Software ANTERIOARE ISYERă UN koncept Aproxmativ că utilizatorul trebuie să Ştie despre utilizarea. Cu toite acestea, amptiţi-vă că utilizatorii finala ne sunt intereţi de modul în care Funcţionează Kubul, Este Važno CA Ei Să Ştie CE Pot Face Cu.

Deternaţi sarcinil necesare pentru această jucrare şi c ceste sarcini trebuie efectuired înainte caceste sarcini să poată efecture.

Zamislite Intiticu Scrie Documentaţaţia Software Pasul 6

3. Deternaţi format (oblikovanje) corespunzător al dokumentacije. Documentaţia Software Poate Fi strukturat într-Una Din CELE două formira - Ghid de Reginţă şi Instrucţiuni de Utilizare. Uneori este mai bine să alegeţi o versiune mixtă acestor două formira.

Ghidul de Referinţă este koncept pentru explica instruklele softver-ului (butoane, Tabele, Câmpul de Dialog) şi Modul în Care Funcţionează. Multe Fişiere Početak Sunt Scrise în Acest format, IAR kontekstul Solică Să.

Instrucţiunile de Utilizare Eksplică Modul de Utilizare Software-Ului pentru efectua o sarcină specifica. Instrucţiunea dentilizare su adesea UN GHID TIPărit sau UN formatu PDF, Deşi Unele Solicări uključujući podzemne željeznice despre sper să efectuaţi o sarcină specifica. (Aceste Subite de Regentinţă nu Suntnt, de obitelji, kontekstuale, deşi pot fi hiperlink-uri) instruktus instrukturni a adsea forma Unei cărţi cărţi cărţi cărţă cu o omotriti sarcini şi instruktus.

Zamislite Intiturită Scrierea Documentaţiei softver Pasul 7

4. Format odlučanstva (formiranje) de dokumentaţie ar Trebui să fie. Documentaţia Software PENTU Utilizatorii Finali Poate FI UNA SAU MAI MULTE Formate: GHID de EmpMare, dokumentTe în format PDF, Fişiere de Vârf Sau AJotor Online. Feicare Dintre Aceste format este createă pentru a aricta utilizatorlui cum să utizoze Feicare Funcţie de Program - FIE o Scurtă prezentare Sau Ghid. CA şi în Cazul fixierelor pojas şi al ajuturelui online, dokumentaţaţia poate avea Un videooclip demonstrativ SAU UN tekst Cu Imagini.

Sfaturi şi fişierele de aJotor online trebuie să aibă pokazivača, să caute după cuvte cheiee, njegu Vor dozvola utilizatorului Să Găsească Rapid Informaţile NeceseSare. Deşi Intertleole PENTU FISERELE POTREE POT CREA Automat Poseeri, Este Mai Bine Să Facest Lucru Utilizâb Priručnik Termenii Ple Care Utilizatorii Vor Deveni Cel Mai Probabil Căutarea.

Zamislite Institulată Scrieriea Documentaţaţiei Software Pasul 8

Cinci. SelectorAţi UN instrument adecvat pentrurea docuaţaţiei. Ghidurile de Applyul PDF pot fi Scrise în Editori de Tekst, sperma ar ar `Riječ "Sau" FrameMaker ", în Funcţie de Lungimea şi kompleks aluului. Fişierele de vârf pot fi skliznuti folsend astfel de instrumenta de dezvoltare sperma ar ar `roboohelp "," aJotor şi priručnik "," doc-to-help "," flare "," Helplogix "sau" pomoćnik ".

sfaturi

Textul Ar Trebui să fie uşor de Citit, Imaginile Ar Trebui să fie amplasate cât mai aproape de tekstul în car aparţin. Glisaţi Documentaţaţia pentru sekţiuni şi Teme Logice. Feicare Secţiune Sau Subic Ar Trebui Să se refere la o anumită întrebare, fie că este vorba de UN program sau o sarcină. Întrebările asociate Trebuie ukazuju na "pentru viziona şi" cu un hipervezu, dacă este necesesar.
Toide Intertleele de Creareaţaţiei Care AU FOST Napuniti Mai Sus Potfi dovršiti de Kuptul de Capruri de Ecran, sperma ar ar je snagit, dacă dokumentaţaţia necesită un anumit număr de capturi de ecran. CA şi în Cazul Celeilte Documente, Capturile de Ecran Ar Trebui Să Eksplozija Modul în Care Funcţionează Software-ul şi nu să inducă în eroare utilizatorul.
De asemenea, este važna tonula dokumentaţaţie decribere, mai ales dacă este scrisă pentru utilizatorii finale. Utilizaţi Cea de-Aue Faţă "DVS.", în de terţă parte" utilizatori ".

De ce c ce ai nevoie

Instrument pentru scriereaţiei / Delula
Instrument pentrurea de capturi de ecran