Rendszerdokumentáció

Fórumok

Aki írt már rendszerdokumentációt, megosztaná velem, hogyan szokás? Miket kell beleírni, milyen mélységig megy el, stb.
Több Linuxos szerverből, néhány windows szerverből és 150 kliensből álló hálózatról kellene írnom dokumentációt.

Hozzászólások

A legjobb módszer ha fogsz egy már elkészítettet és amentén megcsinálod. A következő lépés, hogy megfelel-e az annak amit elvárnak tőled. Megfelel-e a saját igényeidnek. Beleférsz-e az időde?

Boldog vagy. ;)

-- "Bízzál Istenben és tartsd szárazon a puskaport!" - Cromwell --
-- Sayusi Ando - http://sayusi.hu --

Vaze. Kicsit konkrétabban: milyen dokumentációt kell írni?
Ha magadnak írod, akkor tudnod kellene, hogy mi kell neked bele (ami fontos neked), ha másnak, akkor lehet gyengébb vagy bővebb a tartalom. Nincsen ott egy "senior", aki megmondja?

Igen dúrván tud szórni a tartalom onnan kezdve, hogy lerajzolod a topológiát, meg leírod a gépek hardver/szoftver konfigurációját a routolás, alhálózatok, határvédelem, szolgáltatások, elérési szabályok, stb. irányába.

nalunk relative egyszeru volt
dokumentacio:
- bevezeto (mirol szol a doksi)
- celkituzesek (mit szeretnenk elerni a doksival)
- topologiai rajz (fizikai es logikai)
- vlanok reszletezese
- szerverek leirasa (milyen hw, mi fut rajta, mi a feladata)
- kliensek leirasa (milyen hw, mi fut rajta)

1. Deritsd ki, hogy kinek irod a dokumentaciot.

2. Deritsd ki, hogy neki milyen informaciora van szuksege.

3. Ird le ezt az informaciot jol strukturalt, atlathato formaban.

--
The Net is indeed vast and infinite...
http://gablog.eu