документация отново
Ниво: Начинаещи, продължава, мързелив
Какво, пак? Но защо!?
За документацията казва за мнозина, включително Хабре, където намерих няколко статии. Въпреки това, тези статии, които съм виждал (отново. Две. Три. Четири) отговарят на въпросите защо и какво трябва да се документират. Искам две прости примери, които показват как да се води, както и показват, че документацията може да бъде мека и копринена лесно и приятно.
Какво е да водят регистър?
Аз вярвам, че има само един нормален начин за поддържане на документация. Запитайте се какво? Мисля, че трябва да се досети, че това уики. Защо? За възможността аз дори няма да говорим за работа в екип, това е очевидно. Основните предимства на системата уики, виждам следното:
1. Да се съхранява история на редактиране. Винаги можете да видите кой е виновен и някой, който да се отправят ботушите си.
2. Лесен за инсталиране, конфигуриране и използване. Wikis може да се използва навсякъде.
Документация на сървъра
Аз съм най-вече на текстови документи. Но сега аз отделям и да ви разкажа за схемите.
Otsuplenie за блок-схеми
Обичам красива схема, но ги използва само в краен случай, защото те имат основни пропуски.
1. Схемата трябва да бъде изтеглен от уики, промяната и се изсипва обратно. Този недостатък е колко е важно, че аз се съсредоточи върху това конкретно. Така че, което е ключово условие за навременното документация по принцип "документи в движение" и "документи лесно." За смяна на документацията, която трябва да се направи минимален брой стъпки. В действителност, ако, за да се документира, за да се промени в топологията на мрежата или схемата на работа е необходимо да се отвори схемата за клъстер, го променят, и се изсипва обратно, има доста добър шанс да направите това просто няма. И дори и да са, не е радост, защото тя е доста скучна работа.
не могат да бъдат търсени 2. схеми. И дори да се търсят модели за създаването на схеми на програмата може да бъде, независимо дали това ще бъде малко вероятно да се работи, когато веригата е най-вероятно се превръща в един образ, за да бъде включен в уикито.
3. веригата не замества gramnotnoe словесно описание. Разбира се, има неща, които са по-подходящи схема, но в ежедневната си практика, аз бях изправен пред факта, че повечето от нещата, които работят перфектно описва текста, но понякога монолитен схема само за красота.
Така че, текстът
Обичам текстовете. Аз ще кажа, още повече, аз обичам прав текст. Той бързо написан и изразителен достатъчно, ако правилно се използва подложка, която ви позволява да се съсредоточи върху структурата, а не на дизайна. Структурата е най-важното нещо. Така че отново казвам: "Използвайте маржове!" Те ви позволяват да се съсредоточи върху това, което не е описване otvelkayas по отношение на дизайна, и в същото време предоставя информация лесно, структуриран и лесен за четене формат. Може би малко да хвалят? Е, добре.
Шаблонът за описване на сървъра
Така че, тук е представен моделът за описване на сървъра. В това уики, той изглежда толкова добре, колкото тук. Както можете да видите, аз така обичам уплътнение, че се използват много предварително prepre тагове.
Cam шаблон се състои от следните елементи:
1. Име на сървър
2. При условие, услуги
3. специалната
4. система
5. мониторинг
6. Backup