什么是核心要素包括在支持文件？[关闭]

Question

我已经创建了一个 应用程序，它要求'移交' 该支助小组在下一个月。

该应用程序是 相当小 (2个月的发展)，并且由两个客户端应用程序和数据库，它是写在c#为视窗平台。

我有一个广泛的主意 什么，包括在支持文件，但我不需要做很多的支持文件迄今为止在我的职业生涯和我想要一个坚实的项目清单。

我猜我的 目标 是使 生命的每一个人 在支助小组 容易 和压力成为可能。

所以我想我的问题是：

1. 什么样的应有支持文件包含绝对

2. 什么其他的事情你有没有放在支持文件，以使他们额外的有用的。

3. 什么其他活动可以完成的前一方面-过来使我们的生活变得更容易？

Answer 1

已经在双方的这一进程专业的，我可以说，以下应该是 强制性的:

• 该文件代码(如果是的话，为什么不试,doxygen等)
• 详细信息的生成过程
  • 哪里可以得到电源
  • 如何对文件中的错误(他们会发生)
  • 路线，以提供增补程序的来源或以客户
• 它是如何工作(简单，但经常被忽视的)
• 用户定制的部分(例如有一个脚本组)
• 主要接触对于每个组件，aka升级的道路
• 鼓励反馈，支持为什么他们想看到的

我敢肯定很多其他的事情可以加入，但这些都是最高优先事项在我的脑海里。

Answer 2

1. 功能性的规范(如果有)
2. 用户手册。创建一个，如果你没有
3. 技术手册、含有
   • 部署示意图
   • 软件使用
   • 配置和建立详细信息
   • Deatils的服务器ip和管理/oracle/websphere密码
4. 测试文件
5. 在查看文件提供了
   • 在那里的所有文件保持
   • 版本控制库和其项目/用户的详细信息
   • 应用程序的用户名/密码
6. 任何支持SQL s/工具等等创造发展的团队，为分析、装货数据等。

Answer 3

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

Answer 4

• 一usermanual是一个整洁的事情(图片，描述，aso。)
• 一个破旧的不同特征的应用程序

那是什么我想它上面的我的头，如果这是"只是"支持工作人员并不进一步发展。