关于 | Divio 文档

主要观点:要写好软件文档需理解有四种文档类型,分别是教程、如何操作指南、技术参考和解释,它们代表不同目的和功能,需不同创作方法,理解此能大幅提升文档质量及项目等的成功,这里概述的文档系统简单、全面且几乎通用,有相关原则但常被忽视,该系统被大小、开源和专有项目采用,包括多个部分,还可观看 PyCon Australia 2017 的相关视频。
关键信息:有“文档大统一理论”,四种文档类型及相关介绍,文档系统的实践应用及相关内容链接,视频链接
重要细节:文档系统的图片展示,各部分的具体链接,视频的尺寸及嵌入代码等

阅读 21
0 条评论