原文：https://www.ruanyifeng.com/blog/2021/08/weekly-issue-170.html

    介绍一款国产文档工具 ShowDoc。周刊不定期推广优秀的国产软件，有意的朋友欢迎与我联系（Email：yifeng.ruan@gmail.com）。
    软件业有一句名言，感叹文档是多么重要，又是多么难写。
    程序员痛恨两件事：写文档和没有文档。( Coders hate 2 things: writing documentation and no documentation. )
    好的文档工具，可以促进写作，减轻维护负担，给项目和团队带来巨大帮助。ShowDoc 就是这样一款工具，简单易用，符合中国程序员用户的使用习惯，团队用户已经超过 10 万，包括腾讯、华为、百度、京东、字节跳动等知名公司的一些内部团队。
    它主要解决这样一个问题：小团队或者个人开发者，希望有一个开箱即用的文档中心，能够快速地生成、展示、搜索文档，还能够多人协作，划分权限，并且还有桌面的和手机的客户端。 如果你也有这种需求，不妨试试看这个工具。
    image.png
    它的代码完全开源，放在 GitHub 上面，是一个热门项目，超过9000颗星。可以放心使用。
    image.png
    如果你自己有服务器，安装很简单，一行命令就可以了，底层的 Docker 容器自动帮你部署好。Windows 环境也支持，但是安装稍微复杂一点。启动服务后，本机浏览器访问 localhost:4999 ，你就拥有了一个全功能的文档中心，就这么简单。只要绑定域名，就能对外访问。
    image.png
    网站首页上，默认有几个示例仓库，可以点进去看看。
    除了常用的文档库和电子表格库，它还有两个技术文档的特色功能。一个是 API 文档库，解析源码注释，自动生成 API 的说明文档。另一个是数据字典文档，解析数据库结构，自动生成数据库每张表的说明文档。
    为了配合软件 API 文档的生成，官方还特别开发了一个独立服务 RunApi，用来模拟定制 HTTP 请求，完成接口测试、自动流程测试、Mock 数据等功能，类似于 Postman，但它是完全免费的。并且，在调试 API 的过程中，自动生成文档到 Showdoc，极大提高团队的效率。平时调试 API 接口，也可以使用这个服务。
    image.png
    所有 ShowDoc 文档仓库都可以使用 API 自动创建和批量导入，也可以导出为 Word 或 Markdown 文件。每个团队除了公共仓库，成员个人还可以新建私密仓库。
    如果你没有或者不想维护自己的服务器，可以使用官方的在线版托管文档，不超过5人的团队都是免费的。对于那些自己架设服务的团队，官方提供收费技术支持，帮助维护。
    好了，感兴趣的朋友可以试试这个工具，任何问题可以到 GitHub 提 issue 或 QQ 群咨询。