知识转让模板

Question

我在这家公司工作一年多了。

现在他们想让我创建一个KT文档作为参考。

是否有任何模板可供我记录我所做的编码。

Answer 1

我不相信有一个有用的通用模板，所有的模板可能会太大和限制性，以帮助您。您需要写下的内容取决于许多因素：

• 你的角色是什么？
• 软件的大小
• 软件的复杂性
• 预定受众
• 其他角色已经做了什么

在我的脑海中，你可以做的是做一份清单，每个项目看看它自己的代码中包含了什么，或者在其他人的文档中，选择你需要涵盖的内容，向经理报告那些没有涉及到的内容。

使代码自我解释，并在代码中添加注释，应该确保您不必记录大量关于最低代码级别的文档.

我认为程序员的工作人员可以在清单上帮你很多忙，但是要让你开始工作。(请记住，这个列表应该是经过过滤的，希望其他角色(如操作经理、软件架构师、功能设计人员)能够涵盖很多内容)

• 文件的目的
• 预期的受众(也许不仅仅是开发人员，也是应用程序管理人员)
• 软件启用的功能
• 如何启动新的开发人员
• 设计决策(在P&P中可以找到一个很好的决策级别和检查列表)
• 组件及其依赖关系概述
• 技术债务
• 安全性
• 使用第三方工具
• 部署策略
• 数据库结构
• 涉众关心的问题以及软件如何充分地解决这些问题。
• 系统质量属性是如何识别和解决的？
• 机器的用途取决于配置设置。
• 如何安装软件
• 如何回滚软件

当您查看上面创建的列表时，您可以想象出通用模板的大小。

我认为最重要的事情之一是，文档必须有目的，如果您的文档纯粹是为了记录，那是浪费您的时间。有时候，一家公司只是想要达到某种程度的遵从性的文档。