Soorten softwaredocumentatie

Inhoudsopgave:

Anonim

Als u ooit een computerdirectory op een netwerkstation in uw bedrijf met de naam "softwaredocumenten" of "softwaregidsen" hebt gezien en vervolgens naar documenten hebt gekeken die u had mogen bekijken, hebt u waarschijnlijk het aantal documenten en soorten documenten voor software gerealiseerd. talrijk. Het lijkt er ook op dat sommige documenten die in een categorie zijn geplaatst ook op andere categorieën van toepassing zijn. Softwaredocumenten worden in elke fase van een typische softwarelevenscyclus gebruikt, dus dat is een goede plek om het type gemaakte documenten te onderzoeken.

Voorstel

Een softwarevoorstel specificeert de systeemvereisten van het softwarepakket en beschrijft het doel van de software en de problemen die het oplost. Het specificeert ook de geschatte tijd die het softwareproject zal innemen en andere factoren die van invloed zijn op het voorstel.

Haalbaarheidsstudie

De haalbaarheidsstudie vindt meestal aan het begin van het project plaats. Deze fase bepaalt of de softwarefabriek voldoet aan de zakelijke behoeften van de klant. De uitkomst van een haalbaarheidsstudie bepaalt of een project doorgaat of niet.

Vereistenanalyse

Een requirementsanalyse biedt de mogelijkheid om zakelijke vereisten te vertalen in geautomatiseerde software-oplossingen. Een externe consultant of bedrijfsmanagement voert deze taak gewoonlijk uit. De vereisten vertalen bedrijfsvereisten naar daadwerkelijke specificaties voor hardware, software en componenten.

Ontwerpdocumenten

Ontwerpdocumenten vormen de basis voor de ontwikkeling van software op technisch niveau. Zoals de naam doet vermoeden, zal een aantal grafische en tekstuele ontwerpen voor databases, interfaces, communicatie, webontwikkelingen en andere aspecten van de software worden ontworpen voordat de codering kan beginnen.

Coderingsdocumenten

Coderingsdocumenten verwijzen naar de daadwerkelijke broncode die wordt gebruikt voor het programmeren van software. De code kan worden geschreven in een willekeurig aantal beschikbare computertalen, waaronder Java, C ++, PHP en honderden andere computertalen, afhankelijk van het gebruikte systeem.

Documenten testen

Testteams en ontwikkelaars maken testdocumenten in verschillende fasen van de levenscyclus van de software. Ontwikkelaars maken unit-testing documenten voor hun eigen code. Het testteam of andere mensen die niet direct aan de code zijn gekoppeld, ondernemen integratietests en testen van bedrijfseisen.

Gebruikershandleidingen en marketing

Gebruikershandleidingen geven instructies over hoe de nieuwe software werkt. Als het systeem groot en complex is, worden gebruikershandleidingen meestal ondersteund door formele trainingscursussen voor personeel. Marketingdocumenten illustreren de voordelen van het nieuwe softwaresysteem voor potentiële klanten.

Softwarelicenties

Het uitgeven van softwarelicenties maakt de software legaal voor zover het de eindgebruiker betreft. Gebruikers gebruiken software onder de voorwaarden van een softwarelicentie die is uitgegeven door het auteursbedrijf. Niet alle software heeft strikte licentievoorwaarden en dit is met name het geval in het geval van open source. Over het algemeen hebben softwaresystemen een of andere vorm van licentiedocument waarin wordt aangegeven hoe en waar de software kan worden gebruikt.