如何编写技术文档？
原文中文，约2800字，阅读约需7分钟。发表于：。所谓编写技术文档，基本意味着以结构化的方式组织文档，传达出清晰明确的信息，来让用户正确的使用你的软件产品。结构化文档不仅仅是当前最为主流的文档组织方式，在可预见的未来也会如此。 如何编写技术文档？最先出现在Thoughtworks洞见。
软件开发中编写文档很重要，但很少有关于正确组织技术文档的实践方法。文档应该具有清晰的结构，可以使用结构化文档或图谱化文档。选择文档构建方案时要考虑需求和非功能性需求。推荐使用sphinx + 文档象限 + Git或logseq作为知识库。Google Doc/Confluence也是选择，但需要手动管理存档备份。结构化文档组织方式更可靠，图谱化文档需要慎重选择。
