Ano ang dokumentasyon ng software?

Ang software ay tumutukoy sa mga gawain at programa na binuo para sa isang computer system na nagpapahintulot sa paggamit upang magsagawa ng mga gawain o kung hindi man ay makipag -ugnay sa computer.Ang software ay maaaring ibigay ng tagagawa bilang isang sangkap ng system, o nilikha bilang hiwalay na mga aplikasyon ng tagagawa o mga third party. Ang dokumentasyon ay isang paglalarawan ng isang produkto at kung paano gamitin ito.Ang dokumentasyon ng software ay naglalarawan ng mga aplikasyon ng software at kung paano gamitin ang mga ito.Ang ilang mga tipikal na sangkap.Ang unang sangkap na kailangan ng karamihan sa mga gumagamit ay isang gabay sa pag -install, at ang mga hiwalay na gabay ay ibinibigay para sa iba't ibang mga operating system na gumagana ang software, kung kinakailangan.Inililista ng Gabay sa Pag-install ang mga pagtutukoy na kinakailangan upang patakbuhin ang software, kabilang ang mga (mga) operating system ng computer, RAM, puwang ng hard drive, isang koneksyon sa internet, at anumang iba pang mga kinakailangan o add-on, tulad ng mga peripheral.Sinusundan ito ng mga tagubilin sa hakbang-hakbang para sa pag-install, na maaaring mula sa isang CD-ROM, isang DVD, o isang pag-download, halimbawa.Ang anumang hindi pangkaraniwang mga tampok ng installer at paliwanag ng mga pasadyang pagpipilian sa pag -install, tulad ng mga kahaliling lokasyon o naka -streamline na pag -install, ay karaniwang ipinaliwanag.

Ang isang "mabilis na pagsisimula" na gabay ay madalas na ang susunod na bahagi ng naka -print na dokumentasyon ng software na ginamit.Ang pagpili kung saan umalis ang gabay sa pag -install, ang gabay ng mabilis na pagsisimula ay tumutulong sa gumagamit na magsimula sa software at ang mga pangunahing operasyon nito.Ang seksyon na ito ay maaaring isagawa sa iba't ibang mga paraan, dahil nababagay sa partikular na software.Ang isang tanyag na pamamaraan para sa mga application na nakatuon sa gawain ay isang pagpapakilala na batay sa proyekto kung saan natutunan ng gumagamit ang pangunahing pag-andar ng software habang nakumpleto ang ilang mga mini-aralin.

Ang iba pang mga elemento na inaasahan ng isang tao na makahanap sa naka-print na dokumentasyon ng software ay kasama ang isang kumpletong run-down ng mga tampok, na may diin sa mga tampok na bago sa pinakabagong bersyon;isang listahan ng mga pag -update mula noong mga nakaraang bersyon, marahil kabilang ang mga bug na naayos;impormasyon tungkol sa kung paano makakuha ng suporta sa teknikal;mga paliwanag ng mga mensahe ng error;at impormasyon para sa mga advanced, o "kapangyarihan" na gumagamit.Ang mga laro at iba pang mga aplikasyon ng software ay maaaring magsama ng mga cheat sheet o mga pahiwatig sa kanilang dokumentasyon.

Ang naka -print na dokumentasyon ng software ay hindi lamang ang uri.Una sa lahat, ang nakalimbag na dokumentasyon ay maaari ring magagamit online o bilang isang PDF.Ang karagdagang dokumentasyon ay maaari ring magamit sa anyo ng mga tip sa tool at tulong ng mga screen sa loob mismo ng application, FAQS MDASH;Mga listahan ng mga madalas na nagtanong mga katanungan kasama ang mga sagot, mahahanap na artikulo, pagsasanay sa web, video, at iba pang mga format.

Ang dokumentasyon ng software ay nag -iiba nang kaunti sa kalidad, at ito ay partikular na totoo sa mga manual ng software.Ang mga mabubuti ay maaaring maging mahusay, habang ang mga hindi maayos ay maaaring mag-iwan ng mga gumagamit ng maraming mga katanungan.Mayroon ding mga gumagamit na hindi mag -abala upang maghanap ng dokumentasyon bago magtanong sa mga forum ng tagagawa ng software.