c# - 支持文档中包含哪些核心元素？

Question

我创建了一个应用程序，需要在下个月“移交”给支持小组。

该应用程序相当小（开发 2 个月），由两个客户端应用程序和一个数据库组成，它是用 c# 为 windows 平台编写的。

我对支持文档中包含的内容有一个广泛的想法，但到目前为止，在我的职业生涯中，我不需要制作很多支持文档，我希望包含一个可靠的项目列表。

我想我的目标是让支持小组中的每个人的生活更轻松，并尽可能无压力。

所以我想我的问题是：

1. 支持文件绝对应该包含什么

2. 您在支持文档中添加了哪些其他内容以使它们更加有用。

3. 在移交之前可以进行哪些其他活动以使我们的生活更轻松？

Answer 1

专业地参与过这个过程的双方，我可以说以下应该是强制性的：

• 代码文档（javadoc、doxygen 等）
• 构建过程的详细信息
  • 从哪里获得电流源
  • 如何提交错误（它们会发生）
  • 向源或客户提供补丁的途径
• 它是如何工作的（简单，但经常被忽视）
• 用户可定制的部分（例如，有一个脚本组件）
• 每个组件的主要联系人，也就是升级路径
• 鼓励支持人员反馈他们还想看到什么

我确信可以添加很多其他的东西，但这些是我心中的重中之重。

Answer 2

1. 功能规范（如果有的话）
2. 用户手册。如果没有就创建一个
3. 技术手册，包含
   • 部署图
   • 使用的软件
   • 配置和构建细节
   • 服务器 ip 和 admin / oracle / websphere 密码的详细信息
4. 测试文件
5. 概述文件发出
   • 保存所有文件的地方
   • 版本控制存储库及其项目/用户详细信息
   • 应用程序用户名/密码
6. Any support SQL's/tools etc created by the development team, for analysis, loading data etc.

Answer 3

1. 包括操作和输出的屏幕截图。
2. 更喜欢“在线轻松更新”的文档（类似维基）而不是纸质或 pdf。
3. 如果在线，使其可搜索和交叉链接。

Answer 4

• 用户手册是一个整洁的东西（图片，描述等。）
• 应用程序中不同功能的概要

如果这“仅”适用于支持人员而不是进一步发展，这就是我的想法。