2009-10-26 49 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