c# - 支持文档中包含哪些核心元素?

标签 c# .net documentation

<分区>

我已经创建了一个应用程序,需要在下个月“移交”给支持小组。

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

我对支持文件中包含的内容有一个广泛的想法,但到目前为止,在我的职业生涯中我不需要制作很多支持文件,我想要一份可靠的项目 list 包括。

我想我的目标是让支持小组中的每个人轻松并尽可能减轻压力。

所以我想我的问题是:

  1. 一份支持文件应该包含哪些内容

  2. 您在支持文档中加入了哪些额外内容以使其更加有用。

  3. 在移交之前还可以做哪些其他事件来让我们所有人的生活更轻松?

最佳答案

作为专业人士参与过这个过程的双方,我可以说以下内容应该是强制性:

  • 代码文档(javadoc、doxygen 等)
  • 构建过程的详细信息
    • 从哪里获得电流源
    • 如何提交错误(它们会发生)
    • 向源代码或客户提供补丁的路线
  • 它是如何工作的(简单,但经常被忽视)
  • 用户可定制的部分(例如,有一个脚本组件)
  • 每个组件的主要联系人,也称为升级路径
  • 鼓励支持人员就他们希望看到的其他内容提供反馈

我敢肯定还有很多其他的东西可以添加,但这些是我心中的首要任务。

关于c# - 支持文档中包含哪些核心元素?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/205374/

相关文章:

c# - .NET 的自动更新程序和 wyBuild/wyUpdate 的替代品?

c# - 实现接口(interface)的类型的 Entity Framework DBSet 扩展

c++ - 为缺少 XML 文档启用 C++ 编译器警告

.net - 寻找基于 .NET (SQL-Server) 的测试管理工具

python - torch.mean() 源代码的位置

python - Sphinx 自动摘要生成表中的自动换行

c# - Web 应用程序之间的 Asp.Net Core DataProtection 无法在 Azure 上运行

c# - 禁用 WPF 窗口焦点

c# - 没有 C# 的可空特性的可空类型实现

c# - 属性在设置后具有相同的值