sziasztok !
azt szeretném megtudni, hogyan kell egy elvégzett munka dokumentálását
megcsinálni. értem itt a formát, tartalmi jellemzőket, egyebeket.az elvégzett meló tul.képpen amiről már kérdeztem is néhányszor:
-meglévő kliens gépek rendberakása, tartományba szervezés
--szükség esetén windows újratelepítés
--antivírus
-Linux szerver összerakása, szolgáltatások beállítása
--dhcp
--iptables
--samba
--squid
--openvpn
--openssh-server
--mysql server
--később talán egroupware
azt hogy épp mit milyen beállítással oldok meg, vagy épp mit trükközök
és hogyan, azt nem szeretném doksiba foglalni, gondolom ez nem erről
szól.
ami nem világos még ezeken túl, az pl adatvédelmi irányelv.
ez még fontos lehet, mivel gyakorlatilag bármikor találkozhatok olyan
adattal, amely akár személyes, akár hivatali ügy, s nem tartozik másra,
még rám sem, mint adminra.
kérnék tőletek segítséget, hogyan s merre induljak el, hogy meg tudjam
írni ezeket.
nem egy S.O.S. probléma, de ez a feladat is rám vár(na).
köszönettel: bthomyka
- 1449 megtekintés
Hozzászólások
A forma tetszőleges. Érdemes elsőre felvázolni, hogy mégis miről van szó (áttekintés jellegű), majd utána a kívánt mélységig belemenni a témába. Fontos, hogy kinek szól a doksi, mert sokmindent meghatároz. A trükközés pedig fontos lehet, ha mégvalakinek hozzá kell nyúlni vagy neked kell 1,5 év múlva megfejtened a dolgot.
Adatvédelem az meg ott indul, hogy a rendszergazda és tsai. pozíciók speciálisak ilyen szempontból és a munkaszerződésben mindenféle titoktartásokat gondolom megfogadtál. Ezen felül lehet írni adatvédelmi irányelvet amiben szerepel, hogy a mindenkori rendszergazdák roppantul körültekintőek meg bizalmasak. Persze most a hetekben több pánikroham is olvasható volt a neten, hogy a gonosz rendszergazdák mindenben kutatnak és amikor lépnek a cégtől akkor visznek/lezárnak mindent és jajaj. Ezek szerintem elég elszigetelt és extrém esetek, ahol azért meg kéne nézni a munka és egyéb körülményeket is.
- A hozzászóláshoz be kell jelentkezni
Néhány tipp:
- ne a mennyiségre, a minőségre hajts
- legyen áttekinthető (pl. bevezető, rationale stb.)
- bontsd szét aszerint, hogy kinek szól, majd madártávlatból haladj a részletek felé
- hagyd ki a triviális dolgokat, pl. aminek közismert default értéke van, ami egyértelmű (TCP/IP-t használok, így néz ki az IP fejléc) stb., mert ezzel csak átugrik az olvasó egy-két oldalt, átlépve a hasznos infó felett is (vagy pl. topológiát érdemes rajzolni, lefényképezni a szervert már kevésbé)
- nem az a lényeg, hogy az UML szabványnak megfeleljen minden grafikon, hanem hogy a rendszer megfeleljen a leírásnak
- fölösleges dokumentálni a konfigurációs fileokat, azok legyenek a default helyen a szerveren és legyenek ott dokumentálva
- nagy nehézséget az szokott okozni, hogy mivel te építetted a rendszert, már átlátod, próbálj úgy hozzáállni, mintha most vennéd át az üzemeltetést, és hogy akkor mit kellene ehhez tudnod, hogy átláss minden komponenest, és tudj minden alrendszerről
--
The Net is indeed vast and infinite...
http://gablog.eu
- A hozzászóláshoz be kell jelentkezni
Érdemes a konfigfile-okat dokumentálni, főleg ha valami villám beüt, akkor roppant jól jön, hogy jé a doksiban az is megvan és nem kell 34 helyről kibányászni. Ha online doksi lesz, akkor javaslom a markdown nevű varázslatot és persze utána alami PDF jellegűt is, ami dokumentált gépek által minimálisan vagy sehogy sem érintett.
- A hozzászóláshoz be kell jelentkezni
Csak még nagyobb káoszhoz vezet, nagyobb valószínűséggel: idővel mindig csiszolgatnak a konfigon, és közben a doksit senki nem fogja nézni, frissíteni. A két doksi (mert még kommentek nélkül is doksi a konfig) szép lassan aszinkron majd teljes ellentmondás lesz. Két ellentmondó, hiteles doksi pedig rosszabb mint egy se.
Villámcsapás ellen nem a redundáns dokumentáció nyújt védelmet, hanem a redundáns backup.
Ha mégis szükség volna az induláskor használt rendszerkonfigurációra, akkor annak IMHO egy "install cd"-n a helye.
--
The Net is indeed vast and infinite...
http://gablog.eu
- A hozzászóláshoz be kell jelentkezni