支持文档中要包含哪些核心元素?[关闭]

在这一过程的两个方面,我可以说,以下应该是 强制性的 :

• 代码的文档(javadoc、doxygen等)
• 有关生成过程的详细信息
  • 从何处获取当前源
  • 如何归档错误(它们会发生)
  • 向源或客户提供修补程序的路径
• 工作原理(简单,但经常被忽视)
• 用户可自定义部分(如有脚本组件)
• 每个组件的主要联系人,即升级路径
• 鼓励来自支持部门的反馈他们还想看到什么

我相信还有很多其他的东西可以添加,但这些是我心目中的头等大事。

1. 功能规格(如果有)
2. 用户手册。如果没有,就创建一个
3. 技术手册,包括
   • 部署关系图
   • 软件使用
   • 配置和生成详细信息
   • 服务器IP和admin/oracle/websphere密码的详细信息
4. 测试文件
5. 超视图文档分发
   • 所有文件存放的地方
   • 版本控制存储库及其项目/用户详细信息
   • 应用程序用户名/密码
6. 开发团队为分析、加载数据等而创建的任何支持SQL的/工具等。

1. 包括操作和输出的屏幕截图。
2. 更喜欢“在线轻松更新”的文档(类似wiki),而不是纸质或PDF。
3. 如果在线,则使其可搜索和交叉链接。

• 用户手册是一个整洁的东西(图片、描述、ASO)。
• 应用程序中不同功能的概要

如果这仅仅是为了支持人员而不是为了进一步的发展,那就是我的想法。