2009-10-26 50 views
4

我称这是一个闪光的会议,但也许还有另外一个更合适的名称。如何管理和记录Flash会议?

有一段时间(有时候更常见),我的一位开发人员来到我的办公桌前,询问他应该如何编码一段特定的代码。

代码本身并不直接回答某个功能,这意味着它并未在需求期间设计,但是它是功能内部行为的一部分。

讨论5分钟后,我们看中的解决方案。我的问题是,我应该如何记录这个讨论,以便将来当别人查看那段代码时,那个人会理解为什么这样开发,而不是那样?

我是否应该要求开发人员直接在代码中编写讨论摘要,还是应该打开一个Word模板并将讨论记录下来,就好像这是一个2小时的会议?有什么建议么?

回答

3

这是开发维基真正得到回报。您可以为Flash会议创建一个维基页面,并将其链接到其他相关页面。写下所讨论的内容,然后让其他程序员检查并更新他们认为合适的内容。有一个地方来记录一切,你可以将它链接到你需要的任何东西,例如SVN URL到代码分支或链接到其他维基页面所涉及的其他人,该代码库正在进行这项工作。稍后,如果您需要查看它,还可以搜索专门放入wiki页面的关键字,以便稍后查找。

+0

有趣的是,我们这里没有开发wiki,但想法请我。我应该看什么工具? – 2009-10-26 20:14:38

+0

在您的个人资料的问题标签来看,你主要使用C#,所以首先我建议你挑选一个从这个名单http://csharp-source.net/open-source/wiki-engines 注意,有很多和大量的wiki实现,所以不要试图找到最好的。还有一些其他人需要考虑的是用PHP编写的Mediwiki构建维基百科,因为人们可能对它很熟悉http://www.mediawiki.org/wiki/MediaWiki或Confluence,它是Atlassian的商业wiki,可以通过大型可以与其他工具(如JIRA缺陷跟踪工具)集成在一起。 – 2009-10-26 21:48:39

+0

在Stackoverflow上搜索关于开发wiki的内容后,我安装了ScrewTurn Wiki,我们将开始使用这个。谢谢。 – 2009-10-27 16:19:07

0

我的代码做到这一点,只要它不是一篇短文。一个简短的段落,你就完成了。

没有什么比浏览一段代码更困扰我了,然后不得不去寻找一些可以解释它的word文档。

只要它的一个小功能相关的讨论。很有可能,大设计的东西应该进入它自己的元文档。

0

历史信息可以进入版本控制签入注释

在信息可以简单地被捕获,那么一个选项是为开发者描述的讨论在评论时,他/她会检查文件(S )转换成版本控制。如果您不信任开发人员在源代码管理中遇到问题,请在查看源代码的评论中添加“在mm/dd/yy中查看此文件的注释评论”。

+0

不错的主意(15个字符) – 2009-10-26 19:28:51