logseq 是一个非常好用的笔记工具。我们之前已经介绍过关于 logseq 的内容。如果想要了解 logseq，可以看我之前的文章。
在本文中，我们介绍如何将 logseq 作为软件的、项目的文档，以及为什么。
WHY
对于 python 开发者，传统的文档系统有几个，mkdocs，readthedocs。这些文档系统很好用，可以采用纯文本，通过 git 来管理，并且支持富文本，包括markdown 以及 rst。
笔者对于开源项目的文档，有几个假设：
- 开源项目的文档，要放在代码仓库里。
- 文档的变更需要能够追溯。我们可以借助 git 实现。
- 较好的浏览体验
- 开源，以此来保证工具的未来持续可用
因此，我们选用 logseq 直接作为开源项目的文档，以及文档系统。logseq 能够很好的支持不同的文件同步，以及借助 git 实现历史追溯。添加图片也不是难事。
使用 logseq 最大的优势在于其双向连接，以及较好的全文搜索。相比之下，mkdocs 以及 readthedocs，虽然功能强大，但是编辑能力相对弱一些。
HOWTO
想要使用 logseq 作为文档系统，只需要在 logseq 中点击添加图谱，然后在 git repository 中，添加到 docs/目录下即可。
添加完成后，可以单独创建一个[[HOME]]页面，并且收藏，来让用户能够快速找到 HOME 页。对于其他的开发者，也可以通过双向连接来快速找到想要找到的概念。
之后，如果开发者需要修改文档，只需要在 logseq 中进行修改，然后提交到 git 中即可。
结
本文中我们讨论了如何使用 logseq 作为软件项目的文档，简单描述了使用其作为文档的优越性。
当然，使用 logseq 也会引入新的问题。最大的问题是，用户如果不使用 logseq，就完全看不到文档了。除此之外，logseq 的页面公开也不是特别方便。 这些问题应该有对应的解决方案。在这里就不赘述了。