VPF::Документирование системы - Форум программистов

Хоббит

Дата 5.3.2009, 17:14 (ссылка)

(нет голосов)

Загрузка ...

Эксперт

Профиль
Группа: Завсегдатай
Сообщений: 1263
Регистрация: 6.11.2005

Репутация: нет
Всего: 1

Со временем на сервере появляется куча разных скриптов, программ, конфигурация которых опять же лежит в разных местах. В книгах по администрированию, пишут, что всё это надо документировать, записывать и.т.д., чтобы если сервер перейдет другому админу, ему было проще разобраться, что есть где и как.
Что скажете по этому поводу. Документируете ли вы свои системы? В каком виде всё это?

bilbobagginz

Дата 5.3.2009, 18:12 (ссылка)

(голосов:1)

Загрузка ...

Naughtius Maximus

Профиль
Группа: Экс. модератор
Сообщений: 8813
Регистрация: 2.3.2004
Где: Israel

Репутация: 113
Всего: 317

Цитата(Хоббит @ 5.3.2009, 17:14

)

Что скажете по этому поводу. Документируете ли вы свои системы? В каком виде всё это?

методология адинистрации системы ничем не отличается от методологии разработки софта.
значит и документацию надо вести в похожем виде.
smile

пиши скрипты по-человечески, с комментами об ограничениях и целями, чтобы человеку его хачающему было понятно почему сделаны те или иные предположения. Если в скриптах используешь чужие куски кода, которые не понимаешь - обозначь их, чтобы при удобном случае их переписать в читабельной форме.
клади все скрипты в одно место (если можно), давай им понятные имена и т.д.
система версий - коммитить, и делать откаты на предыдущей версии и т.д. для:
- скриптов
- конфигураций системы
можно вообще вести готовую систему конфигураций (cfengine и т.д.)
логические диаграммы строения всех инфо систем, особенно топологии сеток, зависимости от серверов/сервисов
очень важно иметь легко доступный и читабельный список телефонов - поставщики, гарантийки, технари, и т.д.
база знаний - инфосистема, к-рую ты наполнишь готовыми процедурами настройки/установки для твоих нужд по принципу checklist-ов/хау-ту, "настройка сервера -> dns" и т.д., или как тебе удобно.
делай регулярные бэкапы всей документации и системы ведения версий/конфигураций (относясь к ней как к своему софту)

ну, делай так, и будет тебе счастье....

Мир всем smile

--------------------

Я ещё не демон. Я только учусь.

ZeeLax

Дата 5.3.2009, 18:13 (ссылка)

(нет голосов)

Загрузка ...

Эксперт

Профиль
Группа: Модератор
Сообщений: 4388
Регистрация: 20.8.2006
Где: Алма-Ата

Репутация: 26
Всего: 88

Достаточно обширный вопрос. Тут лучше покурить книжку Тома Лимончелли, главу про составление документации. Важна, собственно, не сколько форма, сколько содержательность и легкость восприятия её лицом, никогда не поднимавшем документируемую систему.

Добавлено через 1 минуту и 5 секунд
bilbobagginz, опередил smile

Как раз об этом там и речь, только в развернутом виде.

--------------------

Utility is when you have one telephone, luxury is when you have two, opulence is when you have three — and paradise is when you have none.
— Doug Larson

0 Пользователей читают эту тему (0 Гостей и 0 Скрытых Пользователей)
0 Пользователей:
« Предыдущая тема \| *NIX системы: Общие вопросы \| Следующая тема »