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

Documentation to release and deliver a C++ application to the final customer

本文关键字：C++ 交付应用程序文档客户更新时间：2023-10-16

我想大致了解向商业世界的客户交付C++应用程序（仅限二进制文件，而非源代码）的过程。

例如，当只交付二进制文件（VDD、SVD、README等？？）时，通常会交付哪种文档。当源代码和二进制文件都交付时，会交付什么样的文档？

我一直从事国防部的项目，通常VDD/SVD与源代码一起交付。VDD/SVD包括如何从源代码构建二进制文件的说明，因此通常不需要在VDD/SVD。

对于没有获得源代码（只有二进制代码）的商业客户，通常以文档形式提供什么？谢谢

如果您只提供二进制文件，那么应该有一本手册来描述用户的所有用例，以及管理员应该知道的所有文件和过程（包括安装和删除）的描述，而不必详细说明源代码。

如果您交付源代码，您应该将Doxygen代码注释或您正在使用的任何等效内容导出为某种双方同意的格式。如果源代码没有出现在某个地方的代码注释中，那么还应该描述它是如何组织的。这是对手册的补充。

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