C# 支持文档中包含哪些核心元素?
声明:本页面是StackOverFlow热门问题的中英对照翻译,遵循CC BY-SA 4.0协议,如果您需要使用它,必须同样遵循CC BY-SA许可,注明原文地址和作者信息,同时你必须将它归于原作者(不是我):StackOverFlow
原文地址: http://stackoverflow.com/questions/205374/
Warning: these are provided under cc-by-sa 4.0 license. You are free to use/share it, But you must attribute it to the original authors (not me):
StackOverFlow
What are the core elements to include in Support Documentation?
提问by Matthew Rathbone
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.
该应用程序相当小(开发 2 个月),由两个客户端应用程序和一个数据库组成,它是用 c# 编写的,适用于 windows 平台。
I have a broad ideaof 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 goalis to make the lives of everyonein the support group easierand 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?
支持文件绝对应该包含什么
您在支持文档中添加了哪些额外内容以使其更加有用。
在交接之前还可以做哪些其他活动,让我们的生活更轻松?
采纳答案by warren
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
- 代码文档(javadoc、doxygen 等)
- 构建过程的细节
- 从哪里获得当前来源
- 如何提交错误(它们会发生)
- 向源或客户提供补丁的途径
- 它是如何工作的(简单,但经常被忽视)
- 用户可定制的部分(例如,有一个脚本组件)
- 每个组件的主要联系人,也就是升级路径
- 鼓励支持人员提供反馈,了解他们还想看到什么
I'm sure lots of other things can be added, but these are the top priority in my mind.
我确信可以添加很多其他东西,但这些是我心中的首要任务。
回答by Veynom
- Include Screenshots of operations and output.
- Prefer "online easily update-able" doc (wiki-like) instead of paper or pdf.
- If online, make it searchable and cross-linked.
- 包括操作和输出的屏幕截图。
- 更喜欢“在线易于更新”的文档(类似于维基)而不是纸张或 pdf。
- 如果在线,请使其可搜索和交叉链接。
回答by thmsn
- A usermanual is a neat thing (pictures, descriptions, aso.)
- A rundown of the different features within the application
- 用户手册是一个整洁的东西(图片,描述,aso。)
- 应用程序中不同功能的概述
Thats what i'm thinking ontop of my head if this is "only" for support staff and not further development.
如果这“仅”用于支持人员而不是进一步开发,这就是我的想法。
回答by Dheer
- Functional Specification (If you have one)
- User Manual. Create one if you don't have
- Technical Manual, Containing
- Deployment Diagram
- Softwares Used
- Configuration and build details
- Deatils of Server ip and admin / oracle / websphere passwords
- Testing Document
- Over view document giving out
- Where all documents are kept
- Version Control repository and its project/ user details
- Application usernames / password
- Any support SQL's/tools etc created by the development team, for analysis, loading data etc.
- 功能规范(如果你有的话)
- 用户手册。如果您没有,请创建一个
- 技术手册,包含
- 部署图
- 使用的软件
- 配置和构建细节
- 服务器 ip 和 admin / oracle / websphere 密码的详细信息
- 测试文件
- 概览文件发出
- 保存所有文件的地方
- 版本控制存储库及其项目/用户详细信息
- 应用程序用户名/密码
- 开发团队创建的任何支持 SQL 的/工具等,用于分析、加载数据等。