支持文档中包含哪些核心要素？

Question

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

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

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

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

所以我想我的问题是：

1. 支持文件应包含哪些内容

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

3. 在交接之前可以做些什么其他活动，让我们的生活更轻松？

Answer 1

在专业的这个过程的两个方面，我可以说以下应该 强制 ：

• 代码文档（javadoc，doxygen等）
• 有关构建过程的详细信息
  • 从哪里获取当前来源
  • 如何提交错误（它们会发生）
  • 向源或客户提供补丁的路线
• 它是如何工作的（简单但经常被忽视）
• 用户可自定义的部分（例如，有脚本组件）
• 每个组件的主要联系人，即升级路径
• 鼓励支持人员反馈他们想要看到的内容

我确信可以添加很多其他东西，但这些是我心目中的首要任务。

Answer 2

1. 功能规格（如果有的话）
2. 用户手册。如果您没有
，请创建一个
3. 技术手册，包含
   • 部署图
   • 使用的软件
   • 配置和构建详细信息
   • 服务器ip和admin / oracle / websphere密码的细节
4. 测试文档
5. 过度查看文件
   • 保存所有文件
   • 版本控制存储库及其项目/用户详细信息
   • 应用程序用户名/密码
6. 开发团队创建的任何支持SQL /工具等，用于分析，加载数据等。

Answer 3

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

Answer 4

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

如果这对于支持人员来说是“仅”而不是进一步发展，那就是我在想我的想法。