to be
a problem slover

好用的技术文档方案推荐

概述

好的项目通常有好的文档,好的文档让人看起来赏心悦目。我看过很多的技术文档,其中一些令我印象深刻,本文收集我遇到的一些好的技术文档编写工具。

好文档工具的标准

  • 支持 markdown 编写
  • 支持 github 协作修改,读者也可以帮助完善文档
  • 简洁、清晰、美观、大方
  • 搜索功能强大

我的推荐

通用文档

名称 地址 备注
github wiki github 项目自带的,以前以太坊就是用 wiki 写文档的,效果也很不错
readthedocs https://readthedocs.org/ hyperledger fabrc、bocs 的文档都是用 readthedocs
gitbook https://www.gitbook.com/ 个人写电子书可以用这个, 使用方式参考如何用 gitbook 结合 Markdown 写一本开源书籍
hugo docsy https://example.docsy.dev/docs/ google 开发的 hugo 模板,k8s 的文档就是用这个编写的
confluence http://www.atlassian.com/software/confluence 企业内部用的收费文档平台
腾讯云文档 https://github.com/tencentyun/qcloud-documents/tree/master/product 腾讯云的所有文档都托管在 github 项目里,使用 markdown 编写,然后自己解析
consensys 智能合约最佳实践文档 https://consensys.github.io/smart-contract-best-practices/ 用 mkdocs 文档工具写的,免费开源效果感觉很不错

api 文档我推荐apizza, 这是一个类似 postman 的 api 管理工具,带文档功能,支持一键导出文档。

Last Updated on

赞(2) 打赏
欢迎转载,注明出处:刘世明的博客 » 好用的技术文档方案推荐

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址

觉得文章有用就打赏一下作者

支付宝扫一扫打赏

微信扫一扫打赏