Acest articol tratează despre scrierea tehnică și discută despre modul în care adaptați procesul de scriere pentru a se potrivi diferitelor etape ale nevoilor și cerințelor ciclului de viață al dezvoltării software (SDLC).
Deși există mulți pași în SDLC, acest articol enumeră doar etapele importante ale SDLC. Sunt
1. Colectarea cerințelor
2. Analiză și proiectare
3. Codificare
4. Faza de revizuire și testare a codului
5. Lansare (lansări Alpha și Beta)
6. Întreținere
Fiecare proiect software are propriul cadru SDLC personalizat.
Toate versiunile de cadru proprietare depind de structura scheletului cadrului SDLC de mai sus.
La fel cum fiecare proiect software depinde de SDLC, în același mod, fiecare proiect de documentare depinde și de Ciclul de viață al dezvoltării documentelor (DDLC). Cadrul DDLC este împărțit în următorii pași.
1. Înțelegeți cerințele produsului/proiectului
2. Efectuarea analizei publicului
3. Decizia privind formatele de ieșire (.PDF, Ajutor online) și livrabilele documentației
4. Reducerea la zero pe documentare și instrumente grafice
5. Colectarea documentelor de bază sau sursă
6. Proiectare șabloane
7. Timp și estimare
8. Identificarea experților în materie (IMM-uri) și punctelor de contact
9. Identificarea evaluatorilor colegi, tehnici și editoriali
10. Crearea Planului de documentare
11. Proiect de cuprins (TOC)
12. Dezvoltarea conținutului
13. Gestionarea ciclurilor de revizuire
14. Încorporarea comentariilor de revizuire
15. Ieșire finală
Toți pașii precedenți ai cadrului DDLC pot fi rezumați în cinci subcategorii, care, la rândul lor, pot fi mapate la fiecare pas al SDLC. Cele cinci subcategorii rezumate sunt
1. Întocmirea Planului de documentare
2. Scrierea conținutului
3. Revizuirea conținutului
4. Livrarea documentelor
5. Întreținerea documentelor
Deoarece fiecare proiect de documentare din domeniul software depinde de proiectul/produsul corespunzător, cadrul SDLC al acestuia trebuie mapat cu DDLC-ul proiectului de documentare corespunzător.
Maparea SDLC vs. DDLC
1. Analiza & Proiectare Pregătirea Planului de Documentare
2. Codificare Scrierea conținutului
3. Faza de revizuire și testare a codului Revizuiți conținutul
4. Lansați (versiunile Alpha și Beta) Lansarea documentului
5. Întreținere Întreținerea documentelor (incluzând îmbunătățiri și modificări ale funcționalităților)
După cum puteți vedea din maparea anterioară, fiecare proces din SDLC este mapat cu procesul corespunzător din DDLC. Majoritatea companiilor, în special companiile de produse, doresc ca documentația să fie pregătită până când produsul ajunge pe piață.
Pentru companiile care urmează metodologia Agile, atunci când produsul este în stadiu de dezvoltare, vor exista frecvente îmbunătățiri, corecții etc., în timpul fiecărei iterații. La fel cum sunt încorporate modificările în cod, în același mod, trebuie făcute modificări documentației corespunzătoare pentru a menține livrabilele la zi, conform cerințelor clientului/pieței.