维基用于文档的 5 个绝佳理由

您可能没有注意到，但人们常常对他们最喜欢的技术产生依恋。这可能是一部手机、一种编程语言或一个文本编辑器。当您在别人的项目上工作时，您通常必须使用流行的工具和语言，但当这是您自己的项目时，您可以选择玩具。文档也需要技术，但与 Web 框架和版本控制系统相比，大多数人对文档工具的预设意见较少。那么项目该如何选择呢？

维基是许多开源项目的流行选择。以下是一些原因：

1. 维基提供简单的语法。贡献者只需要学习很少的标记，大多数维基都有一个“格式帮助”链接以提供指导。某些维基上的格式按钮可能意味着零手动标记。
2. 维基不需要贡献者使用特殊的工具。您只需要一个 Web 浏览器。无论您是在台式机还是移动设备上工作都无关紧要。如果有足够的动力，您甚至可以使用 cURL 更新内容。
3. 一些项目托管站点包含维基作为托管服务的一部分。这意味着您可以直接开始编写内容，而无需架设服务器、创建数据库等等。
4. 维基通常内置版本控制。需要回滚编辑吗？只需点击几下即可。
5. 一些维基平台有“讨论”页面，允许进行元讨论。这可能是一种非常有用的方式来讨论内容的更改，这种方式比编辑战更具建设性。

做出决定

维基并非完美无缺。它们不适合以其他格式重新发布或离线编辑。保持内容组织良好以便于查找可能具有挑战性。组织混乱的维基尤其容易出现重复和过时的内容。

但这并不是说您的项目不应该使用维基。如果您希望获得许多人（尤其是技术水平较低的贡献者）的贡献，那么维基是一个不错的选择。Arch Linux 项目尤其在使用维基进行文档方面做得非常出色。

维基非常适合关于特定用例的短篇文章。寻找关于如何将新的 git 分支推送到远程仓库的信息的人可能会觉得一段维基文章比在 50 页的用户指南中查找信息更容易接受。

维基对于快速变化的内容（例如，开发计划）也非常有用。如果您的项目还很年轻并且尚未稳定下来，那么编写长篇文档甚至可能是不可能的。Fedora 项目的发行说明最初是维基页面，稍后会转换为渲染的标记语言，结合了两者的优点。

最好的文档是实际编写出来的文档，因此始终优先考虑维基而不是没有文档。由于入门门槛如此之低，使用维基可能是快速获得大量内容的好方法。只需准备好照料维基花园即可。

本文是 Rikki Endsley 协调的文档专栏的一部分。要为本专栏投稿，请提交您的故事创意或通过 open@opensource.com 联系我们。