文檔一定要注意命名正確:文檔名要正確的反映文檔的內(nèi)容,既不能縮小范圍,也不能擴(kuò)大范圍
軟件工作中的文檔的命名很重要,直觀(guān)的表示文檔的內(nèi)容;
錯(cuò)誤的話(huà),誤導(dǎo)讀者,造成團(tuán)隊(duì)溝通障礙。
另外,文檔內(nèi)部要注意編號(hào)清晰,正確;目的是:提高文檔的可讀性。
posted on 2006-06-08 17:27
石正 閱讀(265)
評(píng)論(2) 編輯 收藏
FeedBack:
# re: 文檔一定要注意命名正確:文檔名要正確的反映文檔的內(nèi)容,既不能縮小范圍,也不能擴(kuò)大范圍
2006-06-08 21:08 |
靠文檔名就能夠正確反映內(nèi)容? 事實(shí)上不同的角度, 一篇文檔可以劃分在許多類(lèi)別中, 所以單純靠名字恐怕是困難的.
所以現(xiàn)在有了象 Wiki 這樣的工具, 而且都在支持 "Tag", 一篇文章可以屬于不同的 Tag(分類(lèi)), 再加上全文檢索, 我想這才是比較合理的文檔管理方法.
回復(fù) 更多評(píng)論
# re: 文檔一定要注意命名正確:文檔名要正確的反映文檔的內(nèi)容,既不能縮小范圍,也不能擴(kuò)大范圍
2006-06-23 12:07 |
文檔管理方法很多,任何一個(gè)團(tuán)隊(duì),一個(gè)個(gè)人,都有一個(gè)逐漸提高的過(guò)程。
您提到的文檔管理工具的使用,的確是很重要的,也是成熟團(tuán)隊(duì)必須的工具,必須的工作方式。
@thinkbase
回復(fù) 更多評(píng)論
淺陋見(jiàn)解,僅供參考。拋磚引玉,多加指教!