Hogyan írjunk dokumentációs szoftver
Az egyik fő tevékenysége a műszaki író, hogy írjon műszaki dokumentáció szoftver.
Fajok, mint dokumentáció sokat: ez előírásokat és vizsgálati módszereket, és a programok, szövegek és kézikönyvek és minden segítséget a felhasználó számára. A kényelmes használat az ilyen dokumentációt kell lennie rövid térfogat releváns tartalom, teljes értelmét.
Kétféle módon az írás műszaki dokumentációt.
1. Eljárás írás műszaki dokumentáció szakértők.
1. meghatározása a szükséges információkat. Ezt a dokumentációt fogják használni a szakemberek (programozók, interfész tervezők), és ezért tartalmaznak pontos információkat a programot. Ők is lehetnek benne:
- A fő alkalmazási fájlok által létrehozott, adatbázis eszközök más programok
- alprogramok és funkciók a magyarázata céljából mindegyikük,
- állandók és a változók terméket jelzi ezek alkalmazására,
- egységes szerkezetben szoftver.
2. Válogatás dokumentumok a befogadás elve a programkód és a teremtés különálló dokumentumokból. Maximum felvétele dokumentáció a programkód könnyebben frissíthető és támogató szoftver.
3. Az eszköz dokumentációját. Ez határozza meg azt a nyelvet, amellyel létre a szoftver és a szükséges okmányok típusa.
2. módszer: Az írás műszaki dokumentáció a végfelhasználók számára.
1. Az alapot a dokumentációt. Dokumentumfilm támogatásra van szükség olyan szoftver termék, a felhasználóknak módja annak alkalmazását és technikai támogatást nyújt. Szintén ilyen dokumentumokat meghatározott jogi feltételeket.
2. Azonosítás a célközönség. Ritkán a felhasználók széles körének szakemberek egy adott területen. Elkülöníteni a célközönség:
- meghatározza a különböző pozíciókat az alkalmazottakat, akik együtt fog működni a szoftverben,
- Megpróbál eleget tenni ezekkel az emberekkel, és hozzon létre saját elképzelése a szint a képzés,
- elsősorban műszaki írás beállított programmal válasz arra a kérdésre, hogy lehet, hogy a termék egy adott felhasználó.
3. Válassza Adatfeed méret írásához műszaki dokumentációt. Általában vagy referencia vezető, illetve a használati útmutató.
4. Válassza ki a dokumentumok formájában (különféle utalások, PDF-fájlok, nyomtatott kézikönyvek, stb.)
5. Válasszon ki egy felhasználóbarát dokumentáció eszköz (szoftver).