Методы для создания хорошей администраторской документации?

Я хочу зарегистрировать любое изменение, которое я делаю к своей системе человечности. Я хочу сделать это способом, что, если бы я должен был передать эту систему другому администратору, это было бы легко и логично, чтобы он получил доступ к этой документации, и используйте его для любой цели. Главная причина, что я хочу сделать, это так, я могу оглянуться назад и видеть exaclly, что сделано для решения проблемы и так далее.

Каков был бы лучший способ сделать это? Я думаю размещение файлов документации и методы создания и просмотра их легко.

Другая причина я хочу изучить хорошую документацию, состоит в том, что в одной из книг LPIC-1 говорится, что это очень importaint, но не уточняет очень предмет.

Надеюсь этот вопрос was'nt к дистрибутиву, независимому или неясному.

Обновление: (сделали некоторые идеи и больше мыслей о предмете),

У меня есть Dell Inspiron 1564 с беспроводной картой BCM4312, на которой драйвер Broadcom Sta/wl вызвал панику ядра. Я не помню все, что я пытался зафиксировать его, и я не помню, как exaclly я решил проблему. У меня также есть проблемы с моим новым драйвером, и я отсутствую не зарегистрировавший это локально.

То, что я хочу, является папкой, которая содержит и документацию относительно того, что было сделано, что установлено в системе и также возможно, ПРАКТИЧЕСКИХ РУКОВОДСТВАХ для новых настольных пользователей. Я хочу пейджер, как less для отображения этих файлов, и я хочу использовать хорошее местоположение для хранения их. (usr/share/doc?) Это в дополнение к комментарию в файлах конфигурации и сценариях.

Я altso хотят создать функцию, которая перечисляет всю документацию. Я думаю, что должен записать сценарий, с опциями создать, распечатать и перечислить мои файлы документа. Я на правильном пути вообще здесь?

Я считаю, что не на самом деле необходимо записать сценарий для этого, но я думаю, что это могло бы быть хорошее изучение, так или иначе. Я думаю что-то простое как это:

  • список docfile #To list all doc files and howto files.
  • docfile-n или filename.howto #Create new/edit file doc tile
  • docfile #View file in pager like less

Да, у меня есть некоторое время на моих руках в данный момент..:)

Сокращать вопрос до крайности: Я хочу простой и изящный способ создать и распечатать документацию локально. Предложение выше (сценарий) разумный способ решить это? И где я должен поместить эти файлы? Действительно ли/usr/source/doc/docfiles является местом для сохранения их?

3
задан 15 September 2013 в 16:39

1 ответ

Создать скрипт.

У нас есть скрипт после установки, когда нам нужно установить новый сервер. После установки базового сервера Ubuntu мы выполняем полуавтоматическую установку apache, mysql и некоторого другого программного обеспечения. Затем мы извлекаем изображение с помощью нашего программного обеспечения и настроек для apache (то есть, с поддержкой сайта) и mysql (то есть, my.cnf).

Самое интересное в Linux - это то, что что-либо является файлом, поэтому в этом скрипте также есть множество выражений «sed», которые изменяют файлы настроек из командной строки. Подумайте о настройках производительности, заданиях cron в /etc/crontab, наших собственных файлах журналов.

Комментарии над командами гарантируют, что кто-либо должен быть в состоянии понять, что происходит.

Наличие этих вещей на бумаге работает только теоретически, но через некоторое время это бесполезно, так как люди забывают обновлять сделанные ими изменения ... Наличие их в сценарии заставит всех обновлять этот сценарий (поскольку это облегчает их работу).

0
ответ дан 15 September 2013 в 16:39

Другие вопросы по тегам:

Похожие вопросы: