wiki文档_Wiki成为文档的5个理由

wiki文档

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

Wiki是许多开源项目的流行选择。原因如下：

Wiki提供了一种简单的语法。贡献者只需学习很少的标记，大多数Wiki都有“格式帮助”链接以提供指导。某些Wiki上的格式化按钮可能意味着零手动标记。
Wiki不需要供贡献者使用的特殊工具。您只需要一个Web浏览器。无论您是在台式机还是移动设备上工作都无所谓。有了足够的动力，您甚至可以使用cURL更新内容。
一些项目托管站点包括Wiki作为托管产品的一部分。这意味着您可以直接编写内容，而不必站立服务器，创建数据库等等。
Wiki通常内置了版本控制。是否需要回滚编辑？只需单击几下。
某些Wiki平台具有“对话”页面，允许进行元讨论。这是讨论内容更改的一种非常有用的方法，其方式比修改编辑更具建设性。

做出决定

维基并不是完美的。它们不适合以其他格式重新发布或离线编辑。保持内容的有序组织使其容易找到可能是具有挑战性的。无组织的Wiki特别容易出现重复和陈旧的内容。

这并不是说您的项目不应使用Wiki。如果您需要很多人的贡献，尤其是技术贡献程度较低的人，那么Wiki是一个不错的选择。特别是Arch Linux项目在使用Wiki进行文档编写方面做得非常出色。

Wiki非常适合有关特定用例的简短帖子。有人在寻找有关如何将新的git分支推送到远程存储库的信息，可能会发现一篇单篇的Wiki文章比找到50页的用户指南中埋藏的信息更容易接近。

Wiki还可用于快速更改内容（例如，开发计划）。如果您的项目尚处于起步阶段并且尚未稳定下来，则甚至可能无法编写长篇文档。 Fedora项目的发行说明以Wiki页面开始，后来被转换为呈现的标记语言，结合了两者的优点。

最好的文档是实际编写的文档，因此始终青睐Wiki，而不是一无所有。由于进入的门槛非常低，因此使用Wiki是快速获取大量内容的好方法。只是准备好照看维基花园。

文件
碟

本文是Rikki Endsley协调的Doc Dish专栏的一部分。 要撰写本专栏文章，请提交您的故事创意或通过open@opensource.com与我们联系。

翻译自: https://opensource.com/business/15/6/wikis-for-documentation

wiki文档

wiki文档_Wiki成为文档的5个理由相关推荐

在线协作文档综合评测：金山文档、腾讯文档、石墨文档
在线协作文档综合评测 :Notion.FlowUs.Wolai.飞书.语雀.微软 Office.谷歌文档.金山文档.腾讯文档.石墨文档.Dropbox Paper.坚果云文档.百度网盘在线文档如今, ...
智能文档理解:通用文档预训练模型
预训练模型到底是什么,它是如何被应用在产品里,未来又有哪些机会和挑战? 预训练模型把迁移学习很好地用起来了,让我们感到眼前一亮.这和小孩子读书一样,一开始语文.数学.化学都学,读书.网上游戏等,在脑子 ...
干掉 Postman？测试接口直接生成API文档，这个文档工具真香！
欢迎关注方志朋的博客,回复"666"获面试宝典实不相瞒我的收藏夹里躺着很多优质的开源项目,我有个爱好平时遇到感兴趣的开源项目都会记录下来,然后有时间在慢慢研究.前几天刚给同事分享 ...
如何利用 nbconvert将 IPYNB文档转换 Markdown文档？
简介: IPYNB文件是现在基于IPython开发工程人员记录和分析处理算法和数据记录文档.将该文档转换成其它格式可以方便面进行思想共享,工作汇报等.利用 nbconvert可以很方便将ipynb的 ...
unity3d api 中文文档_接口文档系统-showdoc安装部署
ShowDoc简介 ShowDoc是一个开源.免费的工具 ShowDoc是一个非常适合IT团队的在线API文档,技术文档工具,它可实现实时同步,用户无需花费过多的精力维护文档. 借助ShowDoc可以 ...
html根据文档定位,html文档中的location对象属性理解及常见的用法
关于location对象的简单理解: 1.location对象中涵盖了当前页面(本页面)或者更直接的说,是当前加载的这个html文档的url信息 2.location对象作为window对象的一个属性 ...
实施文档_Word 2010文档处理案例教程
Word 2010文档处理案例教程 ISBN:978-7-80243-928-3/02 作者:黄桂林江义火郭燕定价:38.00元出版社:航空工业出版社适用层次:通用出版日期:2019-10 ...
利用Aspose.Word控件和Aspose.Cell控件，实现Word文档和Excel文档的模板化导出
我们知道,一般都导出的Word文档或者Excel文档,基本上分为两类,一类是动态生成全部文档的内容方式,一种是基于固定模板化的内容输出,后者在很多场合用的比较多,这也是企业报表规范化的一个体现. 我的 ...
html在分页功能中如何实现当前页面的页码样式与其他页面不同_如何使用word文档？word文档使用技巧教程？...
Word文档使用方法与教程: 使用正确的部分和章节标题我们在前面的章节中介绍了预设样式,但是这些样式可用于快速创建章节,子标题和标题页.在"主页"功能区选项卡中找到样式,可以在其 ...

wiki文档_Wiki成为文档的5个理由

做出决定

wiki文档_Wiki成为文档的5个理由相关推荐

最新文章

热门文章