向最终客户发布和交付C ++应用程序的文档

时间:2013-12-05 18:45:33

标签: c++

我想知道一般来说,向商业世界的客户提供C ++应用程序(仅限二进制文件,而不是源代码)的过程是什么。

例如,当只提供二进制文件时(VDD,SVD,README等等),通常会提供什么样的文档。 当源代码和二进制文件都交付时,会提供什么样的文档?

我一直致力于DoD程序,通常VDD / SVD与源代码一起提供。 VDD / SVD包含有关如何从源代码构建二进制文件的说明,因此通常不需要在VDD / SVD上列出二进制文件列表。

对于没有获取源代码(仅限二进制文件)的商业客户,通常在文档方面提供什么? 感谢。

1 个答案:

答案 0 :(得分:0)

如果您只提供二进制文件,则应该有一本手册描述用户的所有用例,以及管理员应该了解的所有文件和进程(包括安装和删除)的描述,而不会详细介绍源。

如果您提供了来源,则应将Doxygen代码注释或您使用的任何等效注释导出为一些双方同意的格式。如果源代码没有出现在代码注释中,也应该描述源的组织方式。这是手册之外的内容。

这些信息来自我个人的体验,让客户满意。我真的不知道什么是“正常”本身。