问题描述
我已经创建了一个应用程序，它需要'移交'，以支持集团在下个月。
该应用程序的相当小（2个月的开发），以及由两个客户端应用程序和数据库，它是用C＃的Windows平台。
我有什么在支持文档包括了广阔的思路，但我没有必要做非常多的支持文档至今在我的职业生涯，我想项目，以雄厚列表包括。
我想我的目标是要在每个人的生活中在支持组的更容易并作为强调自由越好。
所以我想我的问题是：
-
我应该支持文档绝对包含
-
什么额外的东西把你送到支持文档，使他们额外有用的。
-
还有什么其他的活动可以移交前完成，使我们的生活更容易？
已在此过程中双方的专业，我可以说，下面应该是的必须的
- 的code中的文档（Javadoc中，doxygen的，等等）
- 在生成过程的详细信息
- 在哪里得到的电流源
- 如何提交错误（它们会发生）
- 路线提供补丁要么源或客户
- 在它的工作原理（简单，却往往忽略了）
- 在用户自定义的部分（例如，有一个脚本组件）
- 在每个组件的主要联系人，又名升级路径
- 鼓励从支持反馈，他们希望看到什么
我敢肯定，很多其他的东西可以添加，但这些是首要的在我的脑海。
I have created an application which needs 'hand-over' to the support group in the next month.
The application is fairly small (2 months development), and consists of two client side applications and a database, it's written in c# for the windows platform.
I have a broad idea of what to include in a support document, but I haven't needed to make very many support documents so far in my career and I want a solid list of items to include.
I guess my goal is to make the lives of everyone in the support group easier and as stress free as possible.
So I guess my questions are:
What should a support document absolutely contain
What additional things have you put in support documents to make them extra useful.
What other activities can be done before hand-over to make all our lives easier?
Having been on both sides of this process professionally, I can say that the following should be mandatory:
- the documentation of the code (javadoc, doxygen, etc)
- details on build process
- where to get current source
- how to file bugs (they will happen)
- route to provide patches either to the source or to customers
- how it works (simple, but often overlooked)
- user-customizable portions (eg there is a scripting component)
- primary contacts for each component, aka escalation path
- encouragement for feedback from Support as to what else they want to see
I'm sure lots of other things can be added, but these are the top priority in my mind.
这篇关于什么是核心要素的支持文档，包括？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！