În cazul în care, în plus față de utilizarea și de control, software-ul oferă posibilitatea de a scrie, edita, sau de a folosi codul. Ce documente sunt necesare în acest caz?
Scopul Manualul programatorului
Ghidul programatorului se referă la documentația operațională și tehnică este necesară în cazurile în care sistemul sau în alt mod oferă posibilitatea de a scrie, edita, sau de a folosi codul.
Exemplele includ:
- platformă sau mediu pentru dezvoltarea de software;
- software-ul open source.
- structura de atribuire a funcțiilor de intrare și de ieșire de software;
- capacitatea de a crea un cod de program, în special interpretarea și întocmirea acesteia;
- caracteristici sintactice ale limbajului de programare;
- regulile și limitările codului de program posibile;
- diverse instrucțiuni pentru lucrul cu programul.
Lista de subiecte posibile nu este limitat, totul depinde de caracteristicile sistemului special. Trebuie să spun că manualul programatorului este foarte util pentru proiectanții de sisteme, ca un ghid pentru punerea în aplicare actuală a logicii software-ului.
Compoziția ghid de un programator tipic
În conformitate cu cerințele GOST manualul programatorului trebuie să conțină următoarele secțiuni:
- Numirea și condițiile programului. care indică zona de software de aplicație și cerințele tehnice necesare pentru funcționarea sa.
- Caracteristicile programului. care descriu funcționarea programului, viteza de performanțele sale și alte caracteristici importante pentru utilizare.
- Apel la program. care indică metodele și parametrii de la începutul programului;
- date de intrare și de ieșire. care descriu formatul, organizația, precum și alte cerințe pentru datele de intrare și de ieșire;
- Mesaje. în cazul în care textul mesajelor emise de software-ul în diferite situații și acțiuni care trebuie luate în același timp.
Exemple diverse, ilustrații și tabele este recomandabil să se pună în cererile de documente.