创建良好管理文档的方法?

创建良好管理文档的方法?

我想记录我对 Ubuntu 系统所做的任何更改。我希望这样做,如果我必须将此系统传递给另一个管理员,他可以轻松且合乎逻辑地访问此文档并将其用于任何目的。我想这样做的主要原因是,这样我就可以回顾并确切地了解为解决问题所做的工作等等。

最好的方法是什么?我正在考虑文档文件的放置位置以及轻松创建和查看它们的方法。

我想要学习良好文档的另一个原因是,其中一本 LPIC-1 书籍说这非常重要,但没有对这个主题进行详细阐述。

希望这个问题与发行版无关或者不太清楚。

更新:(对这个问题提出了一些想法和更多思考)

我有一台配备 BCM4312 无线网卡的 Dell Inspiron 1564,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
  • 文档文件 #View file in pager like less

是的,我现在有点空闲时间。:)

简单来说,这个问题:我想要一种简单而优雅的方式来本地创建和打印文档。上面的建议(脚本)是解决这个问题的合理方法吗?我应该把这些文件放在哪里?/usr/source/doc/docfiles 是保存它们的地方吗?

答案1

创建脚本。

我们有一个安装后脚本,用于需要安装新服务器时使用。安装基本 Ubuntu 服务器后,我们会半无人值守地安装 apache、mysql 和其他一些软件。然后,我们会提取一个包含软件和 apache(即启用站点)和 mysql(即 my.cnf)设置的映像。

Linux 的有趣之处在于任何东西都是文件,因此此脚本还包含许多“sed”语句,这些语句可以从命令行更改设置文件。想想性能调整、cron 作业/etc/crontab、我们自己的日志文件。

命令上方的注释确保任何人都能理解正在发生的事情。

将这些内容写在纸上只是在理论上可行,但过了一段时间就没用了,因为人们会忘记更新他们所做的更改...将它们写在脚本中会让每个人都更新这个脚本(因为这会使他们的工作更轻松)。

相关内容