dokumentáció újra
Szint: Kezdő, folyamatos, lusta
Mi, újra? De miért?!
A dokumentáció szerint többféle, köztük Habré, ahol találtam egy pár cikket. Azonban azok a cikkek, hogy láttam (ismét. Kettő. Három. Négy) válaszoljon a kérdésekre, hogy miért és mit kell dokumentálni. Szeretnék két egyszerű példa bemutatja, hogyan kell vezetni, valamint igazolja, hogy a dokumentációt lehet lágy és selymes könnyű és élvezetes.
Mi nyilvántartást vezet?
Úgy vélem, hogy csak egy szokásos módon dokumentálni. Kérdezd meg magadtól, mi? Azt hiszem, már sejtette, hogy ez a wiki. Miért? A lehetőségét meg sem említi a csapatmunka, ez nyilvánvaló. A fő előnye a wiki rendszer, látom a következő:
1. Tartsa a szerkesztési történetében. Bármikor megtekintheti ki a hibás, és valaki, hogy fejét a csizmáját.
2. Könnyen telepíthető, konfigurálható és használható. Wikis bárhol használható.
Dokumentáció a kiszolgálón
Én többnyire szöveges dokumentumokat. De most elkalandoztam, és megmondja a rendszereket.
Otsuplenie körülbelül folyamatábrák
Imádom a szép rendszer, de használja őket csak a legvégső esetben, mert van néhány alapvető hibák.
1. A rendszert meg kell tölteni a wiki, a változás és öntsük vissza. Ez a hátrány az, hogy mennyire fontos, hogy összpontosítson konkrétan. Tehát egyik legfontosabb feltétele az időben dokumentáció elvben „dokumentumok on the fly” és a „dokumentumok egyszerű.” Ha módosítani szeretné a dokumentációban meg kell, hogy egy minimális számú lépést. Valóban, ha dokumentálása érdekében változtatni a hálózati topológia vagy felépítésével munkára van szükség, hogy nyissa ki a klaszter rendszer módosítására, és öntsük vissza, van elég jó esély, hogy ezt egyszerűen nem. És akkor is, ha ez nem öröm, mert elég a házimunkát.
2. azok a rendszerek nem lehet keresni. És akkor is, ha megnézed minták létrehozása rendszerek a program lehet, hogy ez nem valószínű, hogy működik, ha az áramkör valószínűleg átalakítható egy kép beilleszthető a wiki.
3. Az áramkör nem helyettesíti gramnotnoe verbális leírást. Természetesen vannak dolgok, amelyek jobban illeszkednek rendszert, de a mindennapi gyakorlatban, én szembesülnek azzal a ténnyel, hogy a legtöbb dolog, amit tökéletesen leírja a szöveget, de néha öntött áramkör csak a szépség.
Tehát, a szöveg
Szeretem a dalszövegeket. Azt fogja mondani, még jobban szeretem a sima szöveges. Gyorsan gépelt és kifejező elég, ha megfelelően használja padding, amely lehetővé teszi, hogy összpontosítson a szerkezet, nem pedig a design. A szerkezet a legfontosabb dolog. Tehát megint azt mondja: „Use árrés!” Ez lehetővé teszi, hogy összpontosítson, amit leírja, nem otvelkayas a tervezés, és egyúttal tájékoztatást egyszerű, strukturált és könnyen olvasható formában. Talán egy kicsit dicsérni? Na jó.
A sablon leírására a szerver
Szóval, itt van a sablon leírására a szerver. Ebben a wiki, úgy néz ki, ugyanolyan jól, mint itt. Mint látható, Annyira szeretem padding amelyek használata sok előre prepre címkéket.
Cam sablon áll a következő elemeket tartalmazza:
1. Szerver neve
2. Feltéve szolgáltatások
3. A célzott
4. rendszer
5. Monitoring
6. Backup