Inte alla har skrivit programvara dokumentation , men alla har läst dokumentationen till programvaran som lämnade mycket att önska . När vi funderar på att hitta information om ett program , vill vi veta vad den gör , vilka operativsystem och andra program fungerar med , hur vi kan få det , och hur mycket det kostar . Saker du behöver Review, en mjukvara
Visa fler instruktioner
Olika typer av programvara dokumentation
1
Skriv vad programmet gör . Efter att ha läst detta dokument , bör läsaren att kunna avgöra om han behöver programvaran. Var noga med att inkludera alla de funktioner , som ofta kan vara en lista över alla program funktioner .
2
Förklara hur programmet fungerar i förhållande till andra delar av programvara . Detta kan nämna andra delar av program som anses vara competitors.Be säker på att beskriva vad denna mjukvara gör annorlunda än de andra .
3
Beskriv de typer av gränssnitt och kod som används i programvaran. Detta avsnitt bör låta läsaren veta vilken typ av kunskap en användare ska behöva arbeta med denna mjukvara . Denna del av dokumentationen till programvaran används av programmerare och andra tekniska människor .
4
Gör ett dokument för användaren av programvaran så att den som läser den kommer att kunna börja använda programmet . Dessa typer av dokumentation kan vara tutorials . De kan också vara listor med kommandon eller index med där användare kan hitta relevant information .
5
Skriv dokumentation som säljare kan använda när de säljer software.Make säker på att du har inkluderat alla kapacitet och försäljningsställen av programvaran .
