1. 核心竞争力
该产品的和其他同类型产品的对比,他的核心竞争力是什么?即说明为什么在有竞品存在的情况下,还会考虑该产品?
对于一个开源软件,文档要写成什么样一直没有一个明确的说明,许多新产品在写文档材料时也是按照编写者的认知来整理的,这就会导致在编写文档时会更偏向于自己相对熟悉的领域,而对于涉及不深的领域可能考虑不周或者一笔带过,这就导致其他人即使有优化调整的 MR/PR 想提交但却找不到对应的路径。
因此,软件文档目录参考规范
的输出为软件文档的编写提供一个全局整体的参考。即使部分内容没有或者不需要也同样可以为开发者提供思路上的参考,比如开发软件时是否需要考虑高可用、是否需要考虑安全、性能等等,而不仅仅是开发出功能。
而且,目前还没有找到 软件文档目录参考规范
类似的资料,当然也可能是作者的认知范围不足,如有类似的参考希望互相参考完善。