☰

企业 Wiki 组织 - 技术文档

tag-icon • tag-icon untagged
企业 Wiki 组织 - 技术文档

公司有描述其技术系统各个方面的文件，包括：

  • 定制应用程序
  • 定制开发框架
  • 第三方应用程序
    • 会计
    • 错误追踪
    • 网络管理
  • 如何指导
  • 用户手册
  • Web 浏览器
  • 软件工具
    • 发展
      • IDE
    • 显卡
      • GIMP
      • 十五
    • 文本编辑
    • 文件传输
      • FTP服务器
      • 温SCP
  • 硬件
    • 服务器
      • 网页
      • 数据库
      • 交换
      • 文件
    • 网络设备
    • 打印机
  • 图纸

如果您必须使用 Wiki 来管理文档，您会将哪些其他项目添加到列表中，以及如何组织它？（例如，软件工具更有意义第三方应用程序？）

一些限制：

  • 该结构的深度不应超过三层。
  • 避免使用“和”这个词，而应使用两个不同的类别。
  • 保持结构的通用性：它应该尽可能广泛地应用。
  • 目标受众主要是技术人员，但任何人都可以看到。

答案1

我使用 MediaWiki 的类别功能来标记我的 wiki 文档，而不是像上面那样使用层次结构。例如，如果我有一份关于在 Citrix 中设置文件安全状态的文档，我会在文档底部添加类似以下内容：

[[Category:Citrix]][[Category:操作方法]]

其他人都可以加入并根据需要添加类别。在我的主页上，我为那些想要按类别查找文档的人提供了一个指向 Special:Categories 页面的链接。我的存储库现在很小，我的大多数团队要么搜索，要么使用 Special:AllPages 页面。随着存储库的增长，我们可能会决定采用分层结构。目前，我们更关心向 wiki 添加文档，而不是组织文档。

我们正在使用的一个类别似乎在您的列表中缺失，那就是“图纸”。我们使用此类别来存放图表、平面图等。

答案2

这个星球上不存在拥有 GIMP 使用方法的公司。

答案3

我经营着一家小公司的单人商店。我最近重新组织了我的文档 wiki，以使用 IT 专业化作为第一级组。在此之前，它是按使用类型排列的。我绝对喜欢以这种方式组织内容，并且发现更容易让其他人加入进来。我还认为，如果需要的话，以这种方式从头开始阅读会更容易。从记忆中看，它是这样的：

按 IT 专业分类（我现在怎么做的）

  • 桌面支持
    • 电话
    • 打印机
  • 服务器管理员
    • 活动目录
    • WSUS 配置
  • 网络管理员
    • 流量监控
    • VLAN 设置

按任务类型组织（我以前是这么做的）

  • 常规
    • 新用户
    • 新电脑
  • 参考
    • IP 分配
    • 应用
  • 紧急情况
    • 网络中断
    • 服务器故障

答案4

你真的确定要使用 wiki 来做这件事吗？在我看来，它只是迫切需要一个数据库。构建和维护起来要容易得多，而且灵活性也高得多。

至于放什么进去，这确实必须你自己决定，因为我们每个人都有不同的环境和需求。

相关内容