wcobalt Asked:2020-07-03 02:33:40 +0800 CST2020-07-03 02:33:40 +0800 CST 2020-07-03 02:33:40 +0800 CST 文档是为谁编写的？ 772 假设一个团队开发的不是一个可以获取和使用的程序，而是一个供其他程序员使用的库。那么：代码文档是为将要使用该库的人还是为开发它的团队编写的？ документация 3 个回答 Voted Best Answer avp 2020-07-03T04:57:06+08:002020-07-03T04:57:06+08:00 对于那些将使用您的产品的人，有关其使用、安装等的文档。绝对需要。否则，没有人（可能除了少数书呆子）会尝试您的创作。 内部文档（包括描述构建过程）是非常可取的，但通常没有足够的时间来做，整个团队都以自我记录代码为借口。 pepsicoca1 2020-07-03T19:33:02+08:002020-07-03T19:33:02+08:00 关于软件文档有一个明智的 GOST 19.***。这个 GOST 说明了它应该是什么文件以及它应该是什么形式。 简而言之： 对于用户来说，写的是应用程序的描述——即程序和/或库的接口（即调用列表）的描述。 对于开发人员，编写程序的描述 - 这是对程序内部结构的描述，考虑到编写程序的语言中的文本。 Dmitry Kalinin 2020-07-03T02:48:03+08:002020-07-03T02:48:03+08:00 通常编写文档是为了便于理解库（函数或类方法）作为输入接收的内容以及作为输出返回的内容。如果库是公共的，那么它是为每个人编写的，如果它是私有的，那么它是为团队编写的。
对于那些将使用您的产品的人，有关其使用、安装等的文档。绝对需要。否则，没有人（可能除了少数书呆子）会尝试您的创作。
内部文档（包括描述构建过程）是非常可取的，但通常没有足够的时间来做，整个团队都以自我记录代码为借口。
关于软件文档有一个明智的 GOST 19.***。这个 GOST 说明了它应该是什么文件以及它应该是什么形式。
简而言之：
对于用户来说，写的是应用程序的描述——即程序和/或库的接口（即调用列表）的描述。
对于开发人员，编写程序的描述 - 这是对程序内部结构的描述，考虑到编写程序的语言中的文本。
通常编写文档是为了便于理解库（函数或类方法）作为输入接收的内容以及作为输出返回的内容。如果库是公共的，那么它是为每个人编写的，如果它是私有的，那么它是为团队编写的。