software documentarea

13.1. Documentația create și utilizate în procesul de dezvoltare a software-ului

La proiectarea SS-a creat și a folosit o cantitate mare de diverse documentații. Este necesar ca un mijloc de transmitere a informațiilor între dezvoltatorii SS ca un control de dezvoltare înseamnă PS și ca mijloc de transmitere a informațiilor către utilizatori, necesare pentru aplicarea și întreținerea stațiilor. Crearea acestei documentații reprezintă o mare parte din costul stației.

Această documentație poate fi împărțită în două grupe [13,1]

management al documentelor de dezvoltare substație.
Documentele incluse în stația.

Documente PS management de dezvoltare (documentația de proces software) este controlat și înregistrat procesele de dezvoltare și menținere a substații, pentru comunicarea în cadrul echipei de dezvoltare și SS între echipa de dezvoltare si managerii SS (manageri software) - entități care controlează dezvoltarea SM. Aceste documente pot fi următoarele tipuri de [13.1]

Planuri, estimări, orare. Aceste documente sunt create de manageri pentru a anticipa și de a controla procesele de dezvoltare și de întreținere a stațiilor.

Rapoartele privind utilizarea resurselor în procesul de dezvoltare. Creat de către manageri.

Standarde. Aceste documente necesită dezvoltatorii modul în care principiile, normele, acordurile, acestea trebuie să urmeze în procesul de dezvoltare a SS. Aceste standarde pot fi internațional sau național, precum și special creat pentru organizație, care este în curs de dezvoltare SS.

Documente de lucru. Acestea sunt documentele tehnice de bază care asigură o legătură între dezvoltatori. Ele conțin fixarea ideilor și a problemelor care apar în procesul de dezvoltare, descrierea strategiilor și a abordărilor utilizate, precum și lucrătorilor versiuni (temporare) de documente care trebuie să fie incluse în PS.

Note și corespondență. Aceste documente înregistrează diferite detalii ale interacțiunii dintre manageri și dezvoltatori.

Documentele care fac parte din PS (documentația produsului software). descrie programul SS, atât în ceea ce privește utilizatorii lor de aplicare și în ceea ce privește dezvoltarea și escortele lor (în conformitate cu scopul SS). Trebuie remarcat faptul că aceste documente vor fi utilizate nu numai în etapa de funcționare a SS (în fazele sale de aplicare și întreținere), dar, de asemenea, în curs de dezvoltare pentru procesul de dezvoltare de management (inclusiv documentele de lucru) - în orice caz, acestea ar trebui să fie verificate (testate ) pentru conformitatea cu programul PS. Aceste documente formează cele două seturi, cu un scop diferit:

documentația de utilizare pentru PS (P-documentare).

Documentarea în susținerea SS (C-documentare).

13 .2. software-ul documentație pentru utilizator

documentația de utilizare pentru PS (documentație pentru utilizator) explică modul în care utilizatorii acestea ar trebui să acționeze pentru a aplica dezvoltat de PS [13.1, 13.2.]. Este necesar, în cazul în care PS își asumă nici o interacțiune cu utilizatorul. Aceasta include un document care ar trebui să ghideze utilizatorul în timpul instalării PS (la instalarea PS la setarea corespunzătoare privind mediul de utilizare a SS), aplicarea SS-ul pentru rezolvarea sarcinilor lor și în gestionarea SS (de exemplu, atunci când a dezvoltat PS va interacționa cu alte sisteme). Aceste documente sunt afectate parțial probleme de întreținere substație, dar nu abordează problemele legate de modificarea programului.

documentație utilizator Compoziția depinde de publicul de utilizatori, care este orientată dezvoltat de către SS, și modul de utilizare a documentelor. Sub public aici se referă la un contingent de utilizatori PS care au nevoie de o documentație de utilizator specific pentru PS [13.2]. hârtie personalizată de succes depinde în mod esențial de definirea precisă a publicului pentru care este destinat. Documentația de utilizator trebuie să conțină informațiile necesare pentru fiecare segment de public. Sub modul de utilizare a documentului se referă la o metodă care determină modul în care utilizați acest document. De obicei, utilizatorul are doar sisteme software mari necesită documente pentru studiul PS (utilizați ca un ghid), sau pentru a actualiza unele dintre informațiile (utilizare ca un ghid).

În conformitate cu [13.1, 13.2] poate fi considerată o parte tipică următoare documentația de utilizare SS suficient de mare:

Descrierea generală funcțională a MS. Acesta oferă o scurtă descriere a capacităților funcționale ale SS-ului. Conceput pentru utilizatorii care au nevoie pentru a decide cât de mult ai nevoie de ele, această stație.

pentru conducerea de instalare PS. Destinat pentru manageri PS. Acesta va prescrie în detaliu modul de instalare a sistemului într-un anumit mediu, în special, ar trebui să includă o descriere a computerului mediu care poate fi citit pe care este furnizat fișierele PS reprezentând SS, precum și cerințele de configurare hardware minime.

Instrucțiuni de utilizare SS. Conceput pentru utilizatorii obișnuiți. Acesta conține informațiile necesare privind aplicarea SS, organizate sub forma convenabil pentru studiul său.

Referință SS Aplicație. Proiectat pentru utilizatorii obișnuiți. Acesta conține informațiile necesare privind aplicarea SS, organizate sub formă de ușor pentru a căuta în mod selectiv componentele individuale.

FP Ghid de management. Destinat pentru manageri PS. Ar trebui să descrie mesajele generate atunci când MS interacționează cu alte sisteme, și cum să reacționeze la aceste rapoarte, administratorul. În plus, în cazul în care SS folosește hardware-ul sistemului, acest document poate explica modul în care să se mențină acest echipament.

software de suport Documentație

Documentația în sprijinul SS (documentația sistemului) descrie substație în ceea ce privește dezvoltarea sa. Această documentație este necesară în cazul în care substația implică studiul de modul în care este amenajat (proiectat), precum și modernizarea programelor sale. După cum sa menționat deja, suportul - este continuă dezvoltare. Prin urmare, în cazul în care nevoia de modernizare a SS pentru această lucrare o echipă specială de dezvoltatori escorte. Această echipă va trebui să se ocupe de aceeași documentație care definește activitățile echipei de programatori stațiilor inițiale (de bază) - singura diferență este că documentația pentru dezvoltatorii escorte de comandă va tinde ciudat (a fost creat de o altă echipă). Pentru a înțelege structura și procesul de dezvoltare a stațiilor de modernizate, echipa-escorte dezvoltatorii ar trebui să studieze documentația și apoi efectuați modificările necesare, repetând în mare măsură procesele prin care au creat MS originale.

documentație de sprijin FP pot fi împărțite în două grupe:

documentația care definește structura programelor și a structurilor de dezvoltare a datelor și a tehnologiilor PS;

documentație pentru a ajuta la a face modificări la substația.

primul grup de înregistrări care conțin documentele finale ale fiecărei etape a procesului de dezvoltare PS. Acesta include următoarele documente:

Aspectul PS (Cerințe de document).

Arhitectura Descriere PS (descrierea arhitecturii sistemului), fiecare incluzând o specificație externă a programului său (subsistem).

Pentru fiecare program, SS - o descriere a structurii sale modulare, inclusiv specificarea externă a fiecărui modul incluse în ea.

Pentru fiecare modul - specificație și o descriere a structurii (descrierea de proiectare) acesteia.

Module texte despre limbajul de programare selectat (listări de cod sursă de program).

Documentele care stabilesc fiabilitatea SS (documentele de validare), care descrie modul în care să se stabilească veridicitatea fiecărui program de transformare și modul în care informațiile privind stabilirea de credibilitate a fost legat cu cerințele SS.

Documentele care stabilesc fiabilitatea SS includ, mai presus de toate, documentația de testare (testare și descrierea testelor set circuit), dar poate include și alte tipuri de inspecție ale SS-ului, de exemplu, dovada proprietăților programului. Pentru a asigura o calitate acceptabilă a documentației utile să urmeze liniile directoare și standardele [13.3 - 13.8] general acceptate.

Documentarea al doilea grup conține

în sprijinul conducerii SS (ghid de întreținere a sistemului), care descrie caracteristicile punerii în aplicare a SS-ului (în special, dificultățile pe care a trebuit să fie depășite) și modul în care să ia în considerare posibilitatea de dezvoltare a SM în structura sa (design). De asemenea, fixe, care sunt părți hardware-PS și dependente de hardware.

O problemă comună care însoțește SS - pentru a se asigura că toate ideile sale ținut pasul (rămân consecvente), atunci când se schimbă MS. Pentru a ajuta la acest lucru, comunicarea și relația dintre documentele și părțile lor ar trebui să se reflecte în manualul de întreținere, și înregistrate în baza de date de management a configurației.

Exerciții prelegerile 13

13.1. Care este managerul unui instrument software?

13.2. Care este instrumentul software obișnuit de utilizator?

13.3. Ce este instrumentul software-ul de administrator?

13.4. Care este ghid pentru installyatsiiprogrammnogo înseamnă?

13.5. Care este ghid pentru upravleniyuprogrammnym înseamnă?

13.6. Ce este de conducere pentru a sprijini instrumente software?

Literatura Curs 13

Știați că diagrama de implementare, aplicare diagramă, introducerea Diagrama Diagrama de implementare - o metodă de proiectare orientate-obiect, arătând relația fizică dintre componentele hardware și software ale sistemului.

Știri
Cavalerii Teoria eter

anterior ◈ următoarea