狂奔 lion

          自強不息

          關于軟件文檔,我的看法

          文檔應該包括兩大部分,一部分是清晰的代碼結構和注釋,比如Concurrent API就是這樣,還有一部分是文字文檔,包括三個小部分:一是開發文檔,應該講架構和功能;二是索引文檔,詳細介紹功能和參數,三是用戶文檔,包括安裝和使用說明

          文檔最困難的莫過于版本的一致性,當軟件升級后,一些obsolete的內容和新的feature很難同步。要是架構發生了變化,那就更困難了。一般document team都不是太精于技術,所以也會產生一些問題。

          只能說任何事物永遠都有改進的空間,但是同樣也永遠沒有達到完美的程度


           @2008 楊一. 版權所有. 保留所有權利

          posted on 2010-06-29 18:26 楊一 閱讀(327) 評論(0)  編輯  收藏 所屬分類: Other Tech

          <2010年6月>
          303112345
          6789101112
          13141516171819
          20212223242526
          27282930123
          45678910

          導航

          公告

          本人在blogjava上發表的文章及隨筆除特別聲明外均為原創或翻譯,作品受知識產權法保護并被授權遵從 知識分享協議:署名-非商業性使用-相同方式共享 歡迎轉載,請在轉載時注明作者姓名(楊一)及出處(www.aygfsteel.com/yangyi)
          /////////////////////////////////////////
          我的訪問者

          常用鏈接

          留言簿(5)

          隨筆分類(55)

          隨筆檔案(55)

          相冊

          Java

          其他技術

          生活

          最新隨筆

          搜索

          積分與排名

          最新評論

          閱讀排行榜

          評論排行榜

          自強不息


          用心 - 珍惜時間,勇于創造
          主站蜘蛛池模板: 桐庐县| 孟津县| 濮阳市| 磴口县| 桐庐县| 科技| 谢通门县| 抚远县| 诸城市| 当雄县| 桓仁| 梁山县| 大邑县| 云南省| 迁西县| 徐水县| 广昌县| 泰来县| 鄂托克前旗| 吉隆县| 信宜市| 繁昌县| 东阿县| 长寿区| 婺源县| 花莲县| 普宁市| 金寨县| 凌源市| 四川省| 武乡县| 皮山县| 江津市| 离岛区| 新乡市| 绵阳市| 伽师县| 江城| 扎兰屯市| 兴业县| 阳西县|