Documentare din nou
Nivel: Începător, în continuare, leneș
Ce, din nou? Dar de ce!?
Despre documentația spune pentru mulți, inclusiv Habre, unde am găsit câteva articole. Cu toate acestea, acele articole pe care le-am văzut (din nou. Doi. Trei. Patru) răspunde la întrebările de ce și ce trebuie să fie documentate. Vreau două exemple simple, care arată cum să conducă, precum și să demonstreze că documentația poate fi moale si matasoasa ușor și plăcut.
Ce este de a ține evidența?
Eu cred că există doar un singur mod normal, pentru a menține documentația. Intreaba-te ce? Cred că ați ghicit că acest wiki. De ce? Despre posibilitatea nici nu voi menționa munca în echipă, este evident. Principalele avantaje ale unui sistem wiki, am vedea următoarele:
1. Păstrați istoricul de editare. Puteți întotdeauna vedea cine este de vină și cineva la cap cizmele.
2. Ușor de instalat, configurat și utilizat. Wikis poate fi folosit oriunde.
Documentația pe server
Sunt cea mai mare parte documente de tip text. Dar acum am face o digresiune și să vă spun despre schemele.
Otsuplenie despre organigrame
Îmi place schema de frumos, dar le folosesc doar în ultimă instanță, pentru că ei au unele defecte fundamentale.
1. Sistemul trebuie să fie descărcat de pe wiki, schimbarea și se toarnă înapoi. Acest neajuns este cât de important ca să se concentreze pe ea în mod specific. Deci, o condiție esențială pentru documentația în timp util este, în principiu, „documente din mers“ și „documente cu ușurință.“ Pentru a schimba documentația care aveți nevoie pentru a face un număr minim de pași. Într-adevăr, în cazul în care, în scopul de a documenta pentru a schimba în topologia rețelei sau schema de lucru este necesar pentru a deschide sistemul de cluster, modificați-l, și se toarnă înapoi, există destul de o șansă bună de a face acest lucru, pur și simplu nu vor. Și chiar dacă acestea sunt, nu este bucurie, deoarece este destul de o corvoada.
2. sisteme nu pot fi căutate. Și chiar dacă te uiți pentru modele în crearea unor scheme ale programului poate fi, dacă va fi puțin probabil să funcționeze atunci când circuitul este cel mai probabil, transformată într-o imagine pentru a fi inserat în wiki.
3. Circuitul nu înlocuiește gramnotnoe descriere verbală. Desigur, există lucruri care sunt scheme de mai potrivite, dar, în practica lor de zi cu zi, am fost confruntat cu faptul că cele mai multe dintre lucrurile pe care le-am funcționează perfect descrie textul, dar uneori modelat de circuit doar pentru frumusețe.
Deci, textul
Îmi place versurile. Voi spune chiar mai mult, îmi place plaintext. El a scris repede și expresiv suficient, dacă utilizați în mod corespunzător de umplutură, care vă permite să se concentreze asupra structurii, mai degrabă decât pe design. Structura este cel mai important lucru. Deci, din nou, eu spun: „Folosește margini!“ Acestea vă permit să se concentreze pe ceea ce descrii nu este otvelkayas privind designul, și în același timp, să furnizeze informații ușor, structurate și ușor de citit format. Poate un pic pentru a lăuda? Ei bine.
Șablonul pentru a descrie serverul
Deci, aici este șablonul pentru descrierea server. În acest wiki, el arata la fel de bine ca și aici. După cum vedeți, eu place atât de umplutură, care folosesc o mulțime de tag-uri prepre pre.
Șablonul Cam este format din următoarele elemente:
Nume 1. Server
2. Servicii prestate
3. dedicat
4. sistem
5. Monitorizarea
6. Backup