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

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

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

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

Надеюсь, что этот вопрос не был независимым или неясным.

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

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

Что я хочу, это папка, которая содержит как документацию о том, что было сделано, что установлено в системе, так и, возможно, HOWTO для новых пользователей настольных компьютеров. Я хочу пейджер, как less для отображения этих файлов, и я хочу использовать хорошее место для их хранения. (usr/share/doc?) Это дополнение к комментариям в конфигурационных файлах и скриптах.

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

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

  • список документов #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 местом для их сохранения?

1 ответ

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

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

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

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

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

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