Programvara dokumentation genomsyrar cykeln programvara liv . Det är den synliga delen av programvaran processen . Utan det , kan programvaran inte upprätthållas . Utan det , kan användarna inte träna och de praktiskt taget inte kan använda programvaran . Utan det nya utvecklare skulle behöva nytt uppfinna hjulet på mjukvaruutveckling . Programdokumentation är den viktigaste manifestationen av programvara. Det är guiden via programvaran labyrint . Definition av Review Software Dokumentation
Tekniska manualer , bruksanvisningar och andra anvisningar som underlättar användning och drift av en programvara eller tjänster utgör dokumentationen till programvaran . Denna dokumentation kan innehålla vid behov , källkoden , felkoder och deras betydelser . Programvara dokumentation kan också existera i elektronisk form , som en PDF-fil , som en CD eller som en bok .
Software Documentation Standards
Institutet för elteknik och elektronik ( IEEE ) har utformat standarder för mjukvaruindustrin programvara dokumentation . Kallade IEEE 1063-2001 , "Standard för bruksanvisningen Dokumentation , " Dokumentet detaljer innehåll , arkitektur och betydelsen av en programvara dokumentation manual . Den internationella standardiseringsorganisationen ( ISO ) och Internationella elektrotekniska kommissionen ( IEC ) också har fastställt standarder för programvara dokumentation . Deras standarder kallas ISO /IEC 18019-2004 och ISO /IEC TR 9294 . De behandlar programvara dokumentation och dess ledning respektive. Var och en av dessa standarder betonar att programvara dokumentation är en integrerad del av programvarans livscykel .
Funktioner Software Documentation
All programvara livscykel processer i utveckling av programvara redovisas som dokumentationen till programvaran . Programvara dokumentationen fungerar som skriftlig information om krav definitioner , övergripande specifikationer system, specificering av varje komponent och den omfattande test-och underhållsplaner . Configuration Management verktyg är också mycket användbara i dokumentationen till programvaran .
Programvara Dokumentation för utvecklare
betydelsen av programvara dokumentation mjukvaruutvecklare ligger i det faktum att dokumentationen till programvaran innehåller information om driften av programvarusystem . Denna information gör det möjligt att återskapa programvaran eller anpassa det till maintenance.The typ av information som dokumenterats är oftast värd miljoner till mjukvaruföretag . Sådan information skulle kunna gå förlorad om inte dokumenterats som utvecklare kommer och går .
Programvara Dokumentation för slutanvändare
Programvara Dokumentation hjälper slutanvändare uppskattar programmet snabbare .
End - handböcker underlätta samspelet av slutanvändaren med datorn . En utbildning handbok är ett exempel på en användarvänliga manuella . Det minskar lärotid till produktiv användning av programvaran , vilket sparar slutanvändaren miljoner dollar . Slutanvändare dokument kan också vara en referens manual som beskriver de arbetet i systemet eller ett systemadministratörer som beskriver hur att driva och underhålla systemet .
