标签: documentation

你如何记录网络?

我不知道如何问这个问题,因为我不在该领域。假设你是一名网络管理员,你离开了你的工作。新人怎么知道从哪里开始?

networking documentation

66
推荐指数
3
解决办法
3万
查看次数

您如何记录您的工作、流程和环境?

你使用维基格式吗?如果有,是什么产品?(MediaWiki、Confluence、Sharepoint 等)

您是否创建了知识库?(面向问题/解决方案的简短文档。)

您在创建有效的文档时遇到了哪些挑战,因此您在休假时不会接到电话?

对我来说,我发现完成文档通常涉及一定程度的组织“惯性”。似乎是不同类型的人可以完成一项任务,然后考虑他们如何完成任务并描述它以便其他人可以完成 - 对你来说是一种“变元”的力量,并不是每个人都愿意这样做。

更新

到目前为止的答案包括

  • 合流
  • 维基百科
  • 雾虫
  • Mediawiki(带有 fckeditor 等插件)
  • 共享点
  • 维基百科
  • Word/Excel/Visio 文档
  • 记录的脚本

编辑:你不是用你的监控系统隐式记录你的网络吗?Nagios 一直鼓励使用parent指令来反映您的网络结构,notes_url指令旨在允许您链接到 wiki 或其他基于浏览器的文档。因此,此处的“文档”分为监控系统的“活动文档”和 wiki 中更详细的离线文档。因为我花了很多时间盯着 Nagios,所以努力让它尽可能提供信息是有意义的。

documentation process

48
推荐指数
9
解决办法
9778
查看次数

如果你被公共汽车撞了,你的公司会遇到麻烦吗?

在工作中,过去 10 年里,我是唯一的 IT 人员(做这一切,现在就做打字员)。如果我被公共汽车撞到,他们会完全被搞砸。我已经多次向管理层/总裁类型的人提到过,但他们不理会我。对他们来说太糟糕了。

我能做些什么来减轻他们的痛苦?(或者我应该关心吗?)

(是的,这应该是一个社区维基,但是,我没有看到复选框......也许我没有足够的代表。)

documentation

27
推荐指数
3
解决办法
1722
查看次数

开始使用文档

我们没有在我的工作场所做任何文件。我对它完全陌生,并要求提供一些入门指导。

我有几个问题:

  • 系统管理员应该编写和维护的基本文件是什么?为什么这些如此重要?

  • 您如何使文档与系统保持同步?您如何最大限度地减少信息重复?

  • 推荐指南、最佳实践、反模式?

documentation

22
推荐指数
3
解决办法
2409
查看次数

文档作为手册与文档作为检查表

我过去曾与我部门的其他人讨论过文档,特别是详细程度和要求。在他们看来,文档是当 X 件事情出错时 Y 件事情要做的简单清单。

我不同意。我认为这假定 IT 中的所有问题都可以很容易地归结为简单的恢复程序清单。我认为它完全忽略了情况的复杂性,而且由于部门中的其他人并不总是对这个问题有深入的了解(这就是我写文档的原因——所以他们有一些东西可以参考) 文件应包括一些基本的背景材料,例如:

  • 相关(子)系统的目的
  • 为什么以这种方式配置
  • 实施设置/程序时对发生事件的预期
  • 可能导致程序失败的潜在问题

但是,我对此持反对意见,因此需要将我的文档重新编写为“按顺序应用的步骤 ABC 将解决问题 X”的表格。 我经常听到有人感叹它需要放在一页纸上。 尝试通过单页文档以这种方式向某人解释 Squid ACL 的配置,包括故障排除。这只是作为恢复清单“等待写入”的六份文件之一。

我提倡的方法真的过火了吗?或者他们是对的,我应该管好我的生意,给他们写一个简单的清单?我担心的是,无论您编写的程序检查表有多好,它确实无法解决需要系统管理员仔细考虑的问题。如果您正在花费时间执行最终无法解决问题的恢复程序清单(因为由于文档的重点狭窄,还有不属于文档的一部分的其他因素),以及文档是为了避免重新阅读手册页、维基和网站,那我为什么要走过场?是我太担心了,还是这是一个真正的问题?

编辑:

该部门目前没有服务台职位。文档的受众将是其他管理员或部门负责人。

disaster-recovery documentation process

17
推荐指数
4
解决办法
1308
查看次数

如何编写手册页?

如何编写手册页?

我在哪里可以找到所有格式代码的参考?

有没有关于编写手册页的好教程?

编写手册页最方便的方法是什么?我应该直接在文本编辑器中输入吗?有 WYSIWYG 编辑器吗?或者我应该以不同的格式编写它然后转换?

一个好的手册页应该遵循哪些规则?

documentation

16
推荐指数
3
解决办法
1万
查看次数

您如何记录 Windows 服务器配置?

我来自 Unix 背景,其中记录服务配置(例如电子邮件)可能就像获取一些文本配置文件和一两段解释性文本一样简单。

面对记录大量(50 多个)Windows 机器的配置时,我很沮丧地发现查看服务配置是多么困难。我正在从头开始构建这些机器,因此我需要在所有机器上保持配置一致。我将使用 Ghost 或类似方法对所有服务器进行映像,但实际配置服务(如 AD 或 Exchange)是一种手动点击过程,很容易导致不一致。

人们如何建议我着手创建可确保一致性的构建文档?其次,您如何在不诉诸大量屏幕截图等的情况下记录配置?我实际上正在考虑使用 Camtasia 来抓取配置过程的视频,这看起来很荒谬。

谢谢你的帮助!

编辑:下面的一些答案非常有帮助,我认为这会让我达到我想去的地方。特别是,使用应答文件进行脚本化安装将有助于创建一致的安装,并且一些 WMI 工具对于文档(LANsweeper、SYDisproject 等)非常有用。

我真正想要的是有一个工具可以将所有配置输出为人类可读/可编辑的格式,并且还可以再次将其全部吸回。Unix 基本上总是使用自记录配置文件来完成此操作,因此在所谓的现代操作系统中没有相同的功能令人非常失望!

windows configuration documentation

15
推荐指数
3
解决办法
2万
查看次数

MediaWiki 的 IT 文档

我们正在寻找进一步增强我们的文档和允许轻松访问信息以及编辑信息的能力的方法。考虑到这些想法,我们基于 MediaWiki 平台为我们的第 1 层(帮助台)创建了一个内部 wiki。这对帮助台来说是一个巨大的成功,他们将其广泛用于日常运营。现在,我们正在寻找为我们的第 2 层(系统管理员)记录事情的方法。我们需要将第 2 层的信息与第 1 层的信息分开,因为信息的敏感性以及其中包含我们如何构建服务器的步骤等的事实。

我正在寻找有关我们如何实现以下目标的想法和建议:

  • 基于 MediaWiki 平台的集中式文档
  • 第 1 层和第 2 层之间的分离内容
  • 我们喜欢 Tier 1 的外观和感觉,它可以用于 Tier 2
  • 如果我们要运行两个不同的 MediaWiki 安装,这可以在同一台服务器上运行吗?在同一台机器上运行多个 MediaWiki 安装是否是一个好主意?
  • 支持每个文档安装的 FQDN 和 SSL 证书
  • 有没有办法根据用户或组成员身份分割或保留 Tier 1 MediaWiki 安装的单独部分?

在此先感谢您,我期待您的想法和建议。

documentation mediawiki wiki document-management

14
推荐指数
1
解决办法
2388
查看次数

数据中心文档的免费工具

是否有任何免费工具可以帮助更好地记录数据中心的信息,例如机架中的服务器、它所连接的组端口等信息?

documentation datacenter

13
推荐指数
2
解决办法
1万
查看次数

作为 Mac 系统管理员,我可以在哪里记录有用的信息?

我最近对 ​​Mac 上的目录服务工具(dscl、dsimport、dsexport)进行了一些研究,并希望能够将它们记录在某个地方以使所有人受益(也许可以改进我的工作)。如果一个好的网站已经存在,我认为为此目的建立自己的网站没有任何好处。

是否有任何好的 Wiki(或类似的东西)可以记录文本和图像(截屏视频也很酷,但我不指望有这样的地方)作为 Mac 管理员需要了解的有用信息?

documentation mac-osx wiki

13
推荐指数
1
解决办法
611
查看次数