Hogyan írjunk szoftver dokumentációját

előző ◈ a következő

Egy jó program dokumentációját -, hogy ez a dokumentum, amely tartalmazza a specifikáció követelményeinek programozók és tesztelők, műszaki dokumentum belső felhasználók számára útmutatót a szoftver, vagy a felhasználó súgófájlban - segít a személynek, aki a szoftver, hogy megértsük a jellemzőit és funkcióit. Kövesse a tippeket -, hogyan kell írni a program dokumentációját mind technikai, mind a végfelhasználók számára.

lépések szerkesztése

1. módszer a 2:
Írásban szoftver dokumentációjában műszaki felhasználóknak. szabály

Határozza meg, hogy milyen információkat kell említeni. Dokumentumokat szoftver követelmények a kalauz a felhasználói felület a tervezők, programozók, akik kód és a tesztelők, hogy a vizsgálati, legyen szoftver működését. Pontos információ függ a program, de lehetnek a következő:
  • kulcs fájlok az alkalmazás. Lehet fájlok által létrehozott egy csapat, adatbázis, az úgynevezett során a program működése, és a szolgáltatás egy harmadik fél programot.
  • Funkciók és alprogramok. Ez határozza meg az egyes funkciók és szubrutin, beleértve bemeneti és kimeneti értékek.
  • Program változók és állandók, és hogyan használják őket a kérelmet.
  • A teljes szerkezet a program. Az olyan alkalmazások alapján a lemezen, akkor valószínűleg szükség van egy leírást az egyes blokkok és a könyvtárak program, míg a webes alkalmazásokat kell leírni a oldalakról, amelyek a fájlokat.
Döntse el, hogy sok dokumentációt kell a kódot, és mennyit kell választani. Minél több műszaki dokumentáció létre a kódot, annál könnyebb lesz frissíteni a kódot, valamint a dokumentáció tekintetében különböző változatai az eredeti kérelem. Legalább dokumentációt a kódot kell magyarázni a funkciók, eljárások, szoftverek állandók és a változók.
  • Ha a kód elég hosszú, akkor készült egy súgó fájlt, amit tehetünk a kulcsszavas keresés vagy indexet. Ez lesz egy nagy plusz alkalmazások számára, ahol a logika a program oszlik több oldalt, és számos olyan támogatási fájlok, valamint az egyes webes alkalmazások.
  • Néhány programozási nyelvek, mint a Java és .NET Framework (Visual Basic.NET, C #), saját szabványok dokumentálása a kódot. Ilyen esetben kövesse a standard iránymutatást -, hogy hány dokumentumot be kell vonni a programkódot.

2. módszer 2:
Írásban szoftver dokumentációjában végfelhasználók szerkesztése

Határozza meg a kereskedelmi megfontolások a rekordokat. Bár a funkcionális okok szoftver dokumentációját - segítségével a felhasználók megértsék, hogyan kell használni az alkalmazást, vannak más okok, például elősegíti termékek a piacon, javítja a képet a cég és ami a legfontosabb, a költségek csökkentése a műszaki támogatást. Bizonyos esetekben a szükséges dokumentációt megfelelnek bizonyos szabályoknak és a jogszabályi követelményeknek.
  • Semmilyen körülmények között ne a program dokumentációjában nem helyettesítheti a rossz felület. Ha az alkalmazás képernyőn igényel sok magyarázó dokumentumok, akkor jobb, ha változtatni a design, hogy valami intuitív.
előző ◈ a következő