Mga Uri ng Software Documentation

Talaan ng mga Nilalaman:

Anonim

Kung nakita mo na ang isang direktoryo ng computer sa isang drive ng network sa iyong kumpanya na pinangalanang "mga dokumento ng software" o "mga gabay sa software" at pagkatapos ay tumingin sa mga dokumento na may pahintulot kang tingnan, malamang na natanto mo ang bilang ng mga dokumento at mga uri ng mga dokumento para sa software marami. Lumilitaw din na ang ilang mga dokumento na inilagay sa isang kategorya ay nalalapat din sa iba pang mga kategorya. Ang mga dokumento ng software ay ginagamit sa bawat yugto ng isang pangkaraniwang ikot ng buhay ng software, kaya isang magandang lugar upang siyasatin ang uri ng mga dokumento na nilikha.

Panukala

Tinutukoy ng isang panukalang software ang mga kinakailangan sa system ng software at inilalarawan ang layunin ng software at ang mga isyu na nalulutas nito. Titingnan din nito ang tinatayang oras na gagawin ng proyekto ng software at iba pang mga kadahilanan na nakakaapekto sa panukala.

Pagaaral ukol sa posibilidad ng negosyo

Karaniwang nagaganap ang pag-aaral ng pagiging posible sa simula ng proyekto. Ang yugtong ito ay nagpasiya kung ang planta ng software ay nakakatugon sa mga pangangailangan ng negosyo ng kostumer. Ang kinalabasan ng pag-aaral sa pagiging posible ay nagpasiya kung ang isang proyekto ay magpapatuloy o hindi.

Mga Pagsusuri sa Kinakailangan

Ang pagtatasa ng mga kinakailangan ay nagbibigay ng paraan upang isalin ang mga kinakailangan sa negosyo sa mga awtomatikong solusyon sa software. Karaniwang ginagawa ng isang panlabas na consultant o pamamahala ng kumpanya ang gawaing ito. Ang mga iniaatas ay isalin ang mga kinakailangan sa negosyo sa aktwal na mga pagtutukoy para sa hardware, software at mga bahagi.

Mga Dokumento ng Disenyo

Ang mga dokumento ng disenyo ay nagbibigay ng batayan para sa pagpapaunlad ng software upang magsimula sa isang teknikal na antas. Tulad ng nagmumungkahi ang pangalan, ang isang bilang ng mga graphical at tekstuwal na disenyo para sa mga database, interface, komunikasyon, web development at iba pang mga aspeto ng software ay dinisenyo bago coding ay maaaring umpisahan.

Coding Documents

Ang mga dokumento sa coding ay tumutukoy sa aktwal na source code na ginagamit para sa programming ng software. Ang code ay maaaring nakasulat sa anumang bilang ng mga magagamit na mga wika computer, kabilang ang Java, C + +, PHP at daan-daang iba pang mga wika computer depende sa sistema na ginamit.

Pagsubok ng mga Dokumento

Ang mga koponan sa pagsusulit at mga developer ay gumagawa ng mga dokumento sa pagsubok sa iba't ibang yugto ng ikot ng buhay ng software. Nagtatayo ang mga nag-develop ng mga dokumentong unit-testing para sa kanilang sariling code. Ang koponan ng pagsubok o ibang mga tao na hindi direktang nauugnay sa code ay nagsasagawa ng pagsubok sa pagsasama at mga kinakailangan sa negosyo na pagsubok.

Gabay ng Gumagamit at Marketing

Ang mga gabay sa gumagamit ay nagbibigay ng mga tagubilin kung paano gumagana ang bagong software. Kung ang sistema ay malaki at kumplikado, ang mga gabay ng gumagamit ay karaniwang naka-back up sa pamamagitan ng pormal na mga kurso sa pagsasanay para sa mga kawani. Ang mga dokumento sa pagmemerkado ay naglalarawan ng mga benepisyo ng bagong sistema ng software sa mga potensyal na customer.

Mga Lisensya ng Software

Ang paglalabas ng mga lisensya ng software ay nagpapahintulot sa paggamit ng software na legal hangga't ang gumagamit ng end ay nababahala. Ginagamit ng mga gumagamit ang software sa ilalim ng mga tuntunin ng isang lisensya ng software na inisyu ng kumpanya na may-akda. Hindi lahat ng software ay may mahigpit na mga tuntunin sa paglilisensya, at ito ay partikular na totoo sa kaso ng open source. Sa pangkalahatan, ang mga sistema ng software ay may ilang anyo ng dokumento sa paglilisensya sa lugar na tumutukoy kung paano at saan maaaring gamitin ang software.