Het belang van software documentatie

Definitie van softwaredocumentatie

De technische, gebruikershandleidingen en andere instructies die het gebruik en de bediening van een softwareproduct of -services vergemakkelijken, vormen de softwaredocumentatie, die (indien nodig) de broncode, foutcodes en hun betekenis kan bevatten. Het kan bestaan ​​in elektronisch formaat, als een PDF- of CD-bestand of als een boek.

Normen voor softwaredocumentatie

Het Institute of Electrical and Electronic Engineering (IEEE) heeft normen ontwikkeld voor de documentatie van de software-industrie. Het wordt IEEE 1063-2001 genoemd, "Standaard voor gebruikersdocumentatie voor software" en beschrijft de inhoud, architectuur en het belang van een handleiding voor softwaredocumentatie. De Internationale Organisatie voor Standaardisatie en de Internationale Elektrotechnische Commissie (ISO en IEC, idem) hebben ook normen vastgesteld voor softwaredocumentatie. Hun normen worden ISO / IEC 18019-2004 en ISO / IEC TR 9294 genoemd. Ze behandelen respectievelijk documentatie en softwarebeheer. Elk van deze normen benadrukt dat documentatie een integraal onderdeel van de levenscyclus van de software is.

Functies van softwaredocumentatie

Alle softwarelevenscyclusprocessen bij de ontwikkeling van software worden vastgelegd als documentatie. De documentatie dient als schriftelijke informatie over de definitie van vereisten, algemene systeemspecificaties, specificatie van elk onderdeel en uitgebreide test- en onderhoudsplannen. Hulpprogramma's voor configuratiebeheer zijn ook erg handig in softwaredocumentatie.

Software documentatie voor ontwikkelaars

Het belang van documentatie voor ontwikkelaars ligt in het feit dat de eerste informatie bevat over de werking van het softwaresysteem. Met deze informatie kan de software worden gereproduceerd of aangepast voor onderhoud. Het type gedocumenteerde informatie is meestal veel waard voor het softwarebedrijf. Dergelijke informatie kan verloren gaan als deze niet wordt gedocumenteerd, aangezien ontwikkelaars komen en gaan.

Softwaredocumentatie voor eindgebruikers

De eindgebruikershandleidingen vergemakkelijken de interactie van genoemde gebruiker met de computer. Een trainingshandleiding is een voorbeeld van een gebruikersgerichte handleiding. Het vermindert de leertijd voor het productieve gebruik van de software, waardoor de eindgebruiker veel geld bespaart. De documenten van de eindgebruiker kunnen ook een referentiehandleiding zijn, waarin de werking van het systeem wordt beschreven, of een handleiding voor systeembeheerders, waarin wordt uitgelegd hoe het systeem moet worden bediend en onderhouden.

Interessante Artikelen