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

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

您使用的是 wiki 格式吗?如果是,哪种产品?(MediaWiki、Confluence、Sharepoint 等)

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

在创建实用的文档时,您遇到了哪些挑战,以便您在休假时不会接到电话?

对我来说,我发现在完成文档的过程中,组织往往存在一定程度的“惰性”。似乎有另一种人可以先完成一项任务,然后再考虑如何他们完成了任务并进行了描述,以便其他人可以完成它 - 这是一种强迫你“走向元”,但并不是每个人都愿意这样做。

更新

到目前为止的答案包括

  • 合流
  • 弹性维基
  • 雾虫
  • Mediawiki(带有 fckeditor 等插件)
  • 分享点
  • 深圳市德勤科技有限公司
  • Word/Excel/Visio 文档
  • 记录脚本

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

答案1

对工具进行评论。

我们尝试过在线 wiki,但发现了一些限制,这可能是个人喜好问题,但包括文档结构,最重要的是必须连接到文档服务器。

无论您处于离线还是在现场,连接都是一个严重的问题(显然,您可以使用安全的 SSL 连接等来缓解现场问题)。

我们当前的文档流程是:

  • 静态 html 生成器
  • markdown 语法
  • 分布式版本控制系统

我们对文档有一个“正式”的布局,它为菜单提供了结构(以及用于视觉样式等的相关 CSS)。

静态 HTML 生成器

我们使用基于的内部静态 html 生成器立方温度以及许多其他工具:色素文档工具

生成的页面(不是?)显然看起来很丑陋,因为我们大多数人/我们的系统管理员/程序员都知道什么是美观的,但在构建这样的页面时完全缺乏协调。

但是它提供/让我们包含配置文件、示例脚本、pdf 等,而不必担心 html 格式搞砸它或担心在“服务器”上哪里可以找到它进行下载。

如果它不是 HTML,只需将其放入文件夹中并添加指向它的 URL 链接。

HTML 为布局提供了“潜在”结构,并且还提供了知识/内容项之间的“链接”(以及基本结构机制,例如能够创建菜单、内容表等)。使用 HTML,每个用户现在都可以在他们的机器上运行一个小型 Web 服务器,无论是 lighttpd 还是其他小型服务器,或者只是使用 Apache 或 IIS 进行全面运行。

我们所有的机器都具有提供基本 html 服务的功能,并且对我们来说运行得足够好。

MARKDOWN 语法。

我们使用 MARKDOWN、Textish 和或的混合版本重新结构化文本让我们的“创造力”编写文档而不必担心 HTML。

这也意味着每个人都可以使用自己喜欢的编辑器(我在 Windows 和 *Nix 上使用 Scintilla),而这里的其他人使用 vi/vim。

分布式版本控制系统。

我们用Git在用户之间“分发”文档。哦,我们也使用它的版本控制功能。

对我们来说,主要优势在于我们所有人都可以更新文档,而无需连接到服务器,也不必发布“已完成”的作品。我们所有人都可以处理文档的相同部分或不同部分,或者只是使用信息。

就我个人而言,我讨厌被束缚在服务器上更新博客,更不用说 wiki 了。Git 对我们来说很好用。

对工作流程进行评论

Wiki 似乎是知识传播/编纂的“时尚”,但正如其他地方所评论的那样,所有流程都变得难以维持,而找到最能支持您的团队需求且可持续的工具组合将需要时间。

更好的解决方案最终会被发现而不是被强制执行。

答案2

我们已经开始使用维基百科我工作的地方。

摘自 Dokuwiki 网站:

DokuWiki 是一个符合标准、易于使用的 Wiki,主要用于创建任何类型的文档。它的目标客户是开发团队、工作组和小型公司。它的语法简单但功能强大,可确保数据文件在 Wiki 之外仍可读,并简化结构化文本的创建。所有数据都存储在纯文本文件中 - 无需数据库。

我发现 Dokuwiki 最容易实现,因为它不需要数据库,而且设置起来也很容易。还有附加模块,可以使用我现有的Active Directory 帐户登录而不必为每个人创建帐户,这比我发现的许多其他 wiki 系统要好得多。它还具有典型的版本控制功能,您可以看到谁在哪里发布了什么,并且它能够在必要时轻松回滚到以前的版本。它们还包括一个可自定义的主页,您可以在其中轻松更改最适合您环境的任何类型的内容。

答案3

杜库 维基或使用 Sharepoint 来获取适合图表的其他内容。

你很快就会习惯在 wiki 上发帖,而且语法其实并不复杂。它很容易组织信息,方便其他人日后查找。

我使用 visio 制作图表以便更清楚地解释(导出为 JPEG)。

答案4

使用正确的插件,追踪可以成为组合票证和 wiki 系统。这样,您的票证就可以轻松链接到 wiki 文章,反之亦然。

我喜欢几个插件:

  • 私人票务插件。Trac 被构建为一个错误库,其中所有票证及其响应都是公开的。这对于 IT 票证系统来说并不合适,但这个插件解决了这个问题。
  • Trac WYSIWYG 插件。让我们面对现实吧,大多数人不会为了取悦自己而学习 wikisyntax。这为他们提供了一个“所见即所得”的票证和 wiki 页面编辑器。

有很多更多的Trac 的自定义。设置和自定义 Trac 系统并不难,完全符合您的喜好!

相关内容