首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >在支持文档中应该包括哪些核心元素?

问在支持文档中应该包括哪些核心元素?
EN

Stack Overflow用户
提问于 2008-10-15 16:17:35
回答 3查看 17K关注 0票数 7

我已经创建了一个应用程序,它需要在下个月将‘移交’给支持组。

该应用程序是相当小的(2个月开发),由两个客户端应用程序和一个数据库组成,它是用c#为windows平台编写的。

--我对在支持文档中包含什么有一个大致的概念,但是到目前为止,我还不需要制作很多支持文档,我想要一个完整的项目列表。

我想我的目标是为了使每个人的生活变得更容易、更容易、尽可能的不受压力。

所以我想我的问题是::

  1. 一个支持文档应该绝对包含哪些
  2. ,您在支持文档中添加了哪些额外的东西来使它们更有用?
  3. ,在提交之前还可以做哪些其他的活动来使我们的生活变得更轻松?
EN

回答 3

Stack Overflow用户

发布于 2008-10-15 16:36:39

  1. 功能规范(如果有)
  2. 用户手册。如果您没有Diagram
  3. Softwares Used
  4. Configuration / oracle / websphere passwords

,则创建一个包含

  • 部署passwords

的

  • 技术手册,并构建服务器ip和管理/oracle/websphere passwords

的

  • 。

​

测试Document

  • Over视图文档的
  1. 给出了
    • ,其中所有文档都保存了
    • 版本控制存储库及其项目/用户details
    • Application用户名/ password

​

  1. 任何由开发团队创建的支持SQL的/工具等,用于分析、加载数据等
票数 6
EN

Stack Overflow用户

发布于 2008-10-15 16:20:01

  1. 包括操作和输出的屏幕截图。
  2. 更喜欢“联机易更新”文档(wiki样),而不是纸张或pdf。
  3. 如果在线,则使其可搜索和交联。

。

票数 2
EN

Stack Overflow用户

发布于 2008-10-15 16:23:56

  • A用户手册是一个很好的东西(图片、描述、麻生太郎)
  • 应用程序

中的不同特性的概述

这就是我的想法,如果这是“只为”支持人员,而不是进一步发展。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/205374

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档