Questions tagged «documentation»

我不确定该怎么问，因为我不在现场。假设您是网络管理员，就辞职了。新人怎么知道从哪里开始？

66 networking  documentation 

您使用的是Wiki格式吗？如果是这样，哪个产品？（MediaWiki，Confluence，Sharepoint等） 您是否创建了知识库？（面向问题/解决方案的简短文档。） 创建有效的文档会给您带来哪些挑战，从而使您在休假时不会接到电话？ 对我来说，我发现完成文档通常涉及一定数量的组织“惯性”。似乎是另一种可以完成任务的人，然后考虑他们如何完成任务并描述它以便其他人可以执行它-一种对您“施加影响”的力量，并不是每个人都乐于这样做。 更新资料 到目前为止的答案包括 合流 Flexwiki 福布兹 Mediawiki（带有fckeditor等插件） 共享点 维基百科 Word / Excel / Visio文档 记录脚本 编辑：您不是通过监视系统隐式地记录您的网络吗？Nagios一直鼓励使用parents指令来反映您的网络结构，并且notes_url指令旨在允许您链接到Wiki或其他基于浏览器的文档。因此，此处的“文档”在监视系统的“活动文档”和Wiki中更详细的脱机文档之间划分。由于我花了很多时间盯着Nagios，因此尽最大努力使它具有更多信息是有意义的。

48 process  documentation 

在工作中，我是过去10年中唯一的IT人员（全部完成工作，现在键入人员）。如果我被公交车撞到，他们将完全被搞砸。我已经多次向管理人员/总裁型人员提及过，但他们却不理我。对他们来说太糟糕了。 我该如何减轻他们的痛苦？（或者我什至应该在乎？） （是的，这应该是社区Wiki，但是，我没有看到该复选框……也许我没有足够的代表。）

27 documentation 

我们在工作场所没有做任何文档记录。我是新手，请寻求入门指南。 我有几个问题： 系统管理员应编写和维护哪些基本文件？为什么这些这么重要？ 如何使文档与系统保持同步？您如何最大程度地减少信息重复？ 推荐指南，最佳做法，反模式？

21 documentation 

过去，我曾与部门中的其他人讨论过文档，尤其是详细程度和要求。在他们看来，文档是X出问题时要执行的Y事情的简单清单。 我不同意。我认为这是假定IT中的所有问题都可以轻松归结为恢复过程的简单清单。我认为这完全忽略了情况的复杂性，并且由于该部门的其他人员并不总是对此问题有深入的了解（这就是为什么我要编写文档的原因-因此他们需要参考一些内容），文档应包括一些基本的背景材料，例如： 所讨论的（子系统）的目的 为什么以这种方式配置 实施设置/过程时发生的事件期望 可能导致程序失败的潜在问题 但是，我对此颇为不满，因此需要将我的文档重新编写为一种形式，该形式为“应用ABC的步骤才能解决问题X”。 我经常听到它需要放在一张纸上的哀叹。 尝试通过单页文档以这种方式向某人解释Squid ACL的配置，包括故障排除。那只是恢复等待清单中“等待写入”的六个文档之一。 我倡导的方法真的过分吗？还是他们说的对，我应该在这里管我的事，然后给他们写一个简单的清单？我担心的是，无论您编写过程清单的质量如何，它都无法真正解决需要SysAdmin仔细考虑的问题。如果您花时间做一份恢复程序清单，最终导致无法解决问题（由于文档的关注范围狭窄，由于文档中没有其他因素），并且您需要文档的目的是避免再次重新阅读手册页，Wiki和网站，那我为什么要进行这些动议呢？我是不是太担心了，还是这是一个真正的问题？ 编辑： 当前部门中没有服务台职位。文档的读者将是其他管理员或部门负责人。

17 process  disaster-recovery  documentation 

已关闭。这个问题需要更加集中。它当前不接受答案。 5年前关闭。 已锁定。该问题及其答案被锁定，因为该问题是题外话，但具有历史意义。它目前不接受新的答案或互动。 如何编写手册页？ 在哪里可以找到所有格式代码的参考？ 在编写手册页方面有什么好的教程吗？ 编写手册页最方便的方法是什么？我应该直接在文本编辑器中输入它吗？有所见即所得的编辑器吗？还是应该以其他格式编写然后转换？ 好人手册应遵循哪些规则？

16 documentation 

我来自Unix背景，在其中记录服务的配置（例如，电子邮件）可能像抓取一些文本配置文件和一段或两段解释性文本一样简单。 面对记录大量（50多个）Windows盒的配置的问题，我很沮丧地发现获取服务配置的视图有多么困难。我正在从头开始构建这些机器，因此我面临着使所有机器上的配置保持一致的需求。我将为所有使用Ghost或类似设备实用的服务器成像，但是AD或Exchange等服务的实际配置是一个手动的点击过程，很容易导致不一致。 人们如何建议我去创建可确保一致性的构建文档？其次，如何在不依靠屏幕截图等的情况下记录配置？我实际上正在考虑使用Camtasia来获取有关配置过程的视频，这似乎很荒谬。 谢谢你的帮助！ 编辑：下面的一些答案非常有帮助，我认为这将使我有所了解。特别是，使用答案文件进行脚本化安装将有助于创建一致的安装，并且某些WMI工具对于文档编制（LANsweeper，SYDisproject等）非常有用。 我真正想拥有的工具是可以将所有配置吐出为人类可读/可编辑的格式，然后又将其重新吸收。Unix基本上总是使用自我记录的配置文件来完成此操作，因此令人失望的是，在所谓的现代OS中没有相同的功能！

15 windows  configuration  documentation 

我们正在寻找进一步增强我们的文档以及使我们能够轻松访问信息以及编辑信息的能力的方法。考虑到这些想法，我们为第1层（帮助台）基于MediaWiki平台创建了一个内部Wiki。对于帮助台而言，这是一个巨大的成功，他们将其广泛用于日常操作。现在，我们正在寻找方法来记录我们的方法2（系统管理员）的内容。由于信息的敏感性以及该信息将包含构建服务器等步骤的事实，因此我们需要使方法2的信息与方法1的信息分开。 我正在寻找有关如何实现以下目标的想法和建议： 基于MediaWiki平台的集中化文档 第1层和第2层之间的分隔内容 我们喜欢Tier 1可以用于Tier 2的外观 如果我们要运行两个不同的MediaWiki安装，可以在同一台服务器上运行它吗？在同一台计算机上运行MediaWiki的多个安装，这甚至是个好主意吗？ 支持每个文档安装的FQDN和SSL证书 有没有一种方法可以根据用户或组成员身份来分割或保留Tier 1 MediaWiki安装的单独部分？ 预先谢谢您，我期待您的想法和建议。

14 wiki  documentation  mediawiki  document-management 

我最近对Mac上的目录服务工具（dscl，dsimport，dsexport）进行了一些研究，并希望能够在某个地方对其进行文档化，以使所有人受益（也许可以在我的工作得到改进的地方）。如果已经存在一个不错的网站，我认为建立自己的网站没有任何好处。 Mac管理员可以使用文本和图像（也很酷，但我也没有指望这一点）有什么好用的Wiki（或类似的东西），可以在其中记录文档和图像吗？

13 mac-osx  wiki  documentation 

关闭。这个问题是题外话。它当前不接受答案。 想改善这个问题吗？ 更新问题，以使其成为服务器故障的主题。 7年前关闭。 有没有免费的工具可以帮助改善数据中心的文档记录，例如机架中的服务器，所连接的组端口等信息？

13 documentation  datacenter 

关闭。这个问题是题外话。它当前不接受答案。 想改善这个问题吗？ 更新问题，以使其成为服务器故障的主题。 5年前关闭。 我们基础架构小组中的一些人希望升级以开始利用RHEL 6中的新功能。过去，我依靠《 NSA指南》（www.nsa.gov/ia/_files/os/redhat/rhel5-guide- i731.pdf）以保护RHEL 5和CentOS 5的安装。我发现该指南非常宝贵。 有没有人有过以类似方式保护RHEL / CentOS 6的经验？如果是这样，您利用了哪些资源（书面或咨询性）？ 我从一些同事那里听说，版本6在很多方面与版本5明显不同，所以我不想在安全性上留下空白，因为我没有充分考虑这些差异。 Red Hat自己的RHEL 6指南（http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Security_Guide/index.html）真的足够吗？ 有人会说，除非您有令人信服的功能原因，否则您应该推迟从5升级到6，直到NSA之类的组织可以针对您要保护的版本制定具体的指南？ 我感谢您可能收到的任何反馈，即使它会将我引导到一个更合适的论坛。 问候， 麦克风

12 security  documentation  rhel6 

我有大约20个Linux服务器，需要记录其配置。我不是指服务的详细配置，而是用户帐户，数据库，数据库帐户，IP地址，物理位置，SSH端口等。我知道所有这些数据都存储在配置文件中，但我想将其全部集中。我正在考虑只创建一个电子表格来记录这些数据，但是想知道是否有比黑客入侵的电子表格更好的结构（也许是一个小型的php / mysql应用程序），它会更加结构化和完整。 你用什么？

12 linux  documentation 

我看到了部分信息，旧信息，但没有实际的样本文件以及本地的简短注释那样好。 我需要了解odbc.ini和之间的确切关系odbcinst.ini。从表面上看，这是很明显的-在odbc.ini文件的顶部，有一个部分： [ODBC Data Sources] MYDSN = MyDriverName ... 但是，我不确定是否可以在驱动程序或DSN部分中进行设置。 1）我Driver = /path/to/file/.so在两个文件中都有一行，有时值会有所不同。这有道理吗？如果是这样，哪个占上风？ 2）是odbcinst.ini类似于JavaScript的“原型” odbc.ini吗？换句话说，如果我要创建许多具有通用设置的DSN，可以将通用设置从升级odbc.ini为odbcinst.ini吗？ 3）Driver和Setupin有odbcinst.ini什么区别？它们似乎具有相同的价值。这些设置是特定于数据库的还是通用的？

11 linux  configuration  documentation  unixodbc 

当前是否有可用的工业标准IEEE，ISO，ANSI ....说明应如何在机架和千斤顶上标记建筑物的物理基础设施以及应如何布置文档？我知道这里有IEEE Std 200，但是已经过时了，我发现了ASME的电气标准，但实际上我看不懂。

11 networking  documentation  cable 

今年晚些时候，我将把教会的活动目录服务器的支持移交给其他人，并想知道什么样的信息对记录和共享很重要。我可以使用任何好的示例文档吗？

9 active-directory  documentation