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

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

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

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

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

所以我想我的问题是：

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

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

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

Answer 1

专业地处理这个过程的两个方面，我可以说以下应该是强制性的 ：

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

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

Answer 2

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

Answer 3

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

Answer 4

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

多数民众赞成在我的脑海里，如果这只是“支持人员”，而不是进一步发展。