Documentation 项目';在处理大量业务逻辑规则时,需要编写文档。如何组织?

Documentation 项目';在处理大量业务逻辑规则时,需要编写文档。如何组织?,documentation,communication,wiki,Documentation,Communication,Wiki,就业务逻辑数量和组件数量而言,我正在从事一个相当复杂的项目 每个开发人员主要使用“自己的”组件。我知道这不是很跨功能,但不可能知道每个组件的详细信息 sostav团队会不时发生变化。所以我们有这样的情况,一个人必须处理“另一个人的组件”。这可以是定期的,所以你可以在一个月后再讨论这个问题-在这个时候你可以一次又一次地问组件业务逻辑的所有者同样的问题,因为你可以在一个月后忘记一些微小但重要的细节 这种情况有时令人讨厌 我们每天都有站立会议,当这个人讲述他已经做了什么和将要做什么时。 我们有项目的w

就业务逻辑数量和组件数量而言,我正在从事一个相当复杂的项目

每个开发人员主要使用“自己的”组件。我知道这不是很跨功能,但不可能知道每个组件的详细信息

sostav团队会不时发生变化。所以我们有这样的情况,一个人必须处理“另一个人的组件”。这可以是定期的,所以你可以在一个月后再讨论这个问题-在这个时候你可以一次又一次地问组件业务逻辑的所有者同样的问题,因为你可以在一个月后忘记一些微小但重要的细节

这种情况有时令人讨厌

我们每天都有站立会议,当这个人讲述他已经做了什么和将要做什么时。 我们有项目的wiki F.A.Q.页面——我们提取了最常见的问题

你觉得这个问题怎么样


您建议我们如何解决这个问题?

考虑到我所使用的组件的性质:

1.)说明应用目的、设置、要求等的框架文件。 2.)每个组件的模块文档采用通用格式,并按名称编制索引

请参阅,以获取通用文档和模块/组件文档的良好示例


哦,而且日常会议通常都很糟糕,它们占用了很多时间,答案也被遗忘了。新来者或病人错过会议,必须重新听取简报。除非需要讨论/反馈,否则最好将其全部写下来并保留一份书面/电子邮件记录。

考虑到我所使用的组件的性质:

1.)说明应用目的、设置、要求等的框架文件。 2.)每个组件的模块文档采用通用格式,并按名称编制索引

请参阅,以获取通用文档和模块/组件文档的良好示例

哦,而且日常会议通常都很糟糕,它们占用了很多时间,答案也被遗忘了。新来者或病人错过会议,必须重新听取简报。除非需要讨论/反馈,否则最好将其全部记录下来,并保留书面/电子邮件记录