怎麼才能寫好技術文檔

有很多人都覺得我文檔寫的好。這不是一兩個人說了。 我記得大概是在創業工作的時候,從寫業績點文檔開始的。那時候,我自己給做了一套模板。每次都按照這個格式寫。每次都能得到領導的好評。既把自己的工作都寫進去了,還弄了個好名聲。 在東信工作的時候,我就是軟體組總體設計,專門寫設計文檔。寫的還算好。每個人都覺得寫的還算好。 有朋友說讓我介紹介紹經驗。那我就在這裡說說。其實,世上無難事,是怕有心人啊。要做好一件事情,只要真心對待總能做好的,下面是關於寫文檔的一點心得。寫出來,以供探討。本文主要討論科技說明文

簡單有限狀態機器(FSM)的實現

通用Gate方式的FSM介面,//-------------------------------------------#include "IGateState.h"#include <assert.h>#include <iostream.h>//-------------------------------------------//-------------------------------------------class IGateFSM  {public: 

微軟團隊:成功秘訣(3)

原文:http://www.blogjava.net/leeguannan/category/29681.html 設計   軟體的設計─每一位團隊成員都必須參與─這表示團隊整體對功能需求的瞭解程度。    軟體設計的第一要訣是:將全團隊中最好的想法組織起來,去滿足顧客內心最深處的需要。(帶領團隊做案例研討,帶領大家思考如何解決一切的疑難,讓每一件事都在該做的時候做好。)法則十九:    Go for greatness    追求卓越法則二十:    State your theme   

同步轉為非同步OO解決之道

        同步和非同步是完全兩種不同的形式, 由於調用的方式不一樣,導致了程式的寫法不一樣,寫法不一樣,自然就影響到了整個軟體架構的設計。在這裡給出一種可行的方法,在基本不影響到架構的情況下,進行軟體的改造。       問題的背景是這樣的,以前的開發是用同步的方式,業務層邏輯統一在一個class 比如就叫CBiz好了,彙總了一個CModemSyn的類,  

微軟團隊:成功秘訣(4)

原文:http://www.blogjava.net/leeguannan/category/29681.html法則二十七:   Be like the doctors    用醫生的方法    當病人已經藥石罔效時,醫生通常會對病情有所保留,避免病人太過悲觀或恐懼,並且盡量鼓勵病人保持希望,最好能讓病人有個期望完成的目標。    醫生絕對不會斬釘截鐵地斷言什麼醫學行為一定會有什麼樣的結果,反而是以 一種自在且充滿信心的口吻說:“試試看吧,一切都還沒有確定呢。   

用反射與自訂屬性實現單元測試工具(NUnit)

反射是.Net、Java等託管語言區別於傳統語言(C++,Delphi等)的一大特性,通過反射我們可以動態建立類,調用方法等。考慮了一下NUnit的功能,覺得利用這個特性也可以做一個出來,於是就動手做了個練習,基本達到了效果,類比NUnit提供架構如下://=======================================UnitDll (類比nunit.framework)[AttributeUsage(AttributeTargets.Class)] public class

PM experience in brief

  After hard working of serveral months, I've finally finished  this project involving 12 team memebers, it's time to have a rest and discuss something via this period, something is good implemented, and something we can't control very well and

用完成連接埠關聯檔案操作

完成連接埠”模型是Window平台最複雜同時也是效率最高的的一種I/O模型,在Socket伺服器上得到了廣泛的應用,“從本質上說,完成連接埠模型要求我們建立一個Win32完成連接埠對象,通過指定數量的線程,對重疊I/O請求進行管理,以便為已經完成的重疊I/O請求提供服務。”(引自《Window網路編程》)  

PBHelper V1.0.0 發布,並已開源

關於PBHelper(PBCOMMENT)這個軟體,最新版本 1.0.0PBHelper的前身是 PBCOMMENT 7.0。================================================================著作權 (c) 1999-2000 RC Sizer  保留所有著作權。著作權 (c) 2003 SCST Co.,Ltd.  保留所有著作權。著作權 (c) 2002-2006 TRUEWAY(TM)  保留所有著作權。註冊商標

成功前的“ 偏 離 ”

             成 功 前 的 “ 偏 離

系統分析師必備要素

1、有效資訊技術知識      包括了電腦應用(軟體專業)所學的基本課程,大致包括:資料結構、作業系統、軟體工程、工程經濟、資料庫原理、進階語言編程、物件導向編程、電腦網路與通訊、彙編、組成原理、電腦系統結構,還有基礎課:高數、離散、機率、線性代數、物理(工科類)等等。     系統分析師考試範圍內要求的各基礎知識要點。     這些知識構成了系統分析師的基礎知識結構。也是拓展自身能力的基石。2、至少具備良好的英語閱讀能力   

Vocational Traits of research personnel

Today, I have a train about Vocational Traits of research personnel. I really have learned someting from the training. about PM, it's really big and complicated topic. so I have no time to exchange my opinion with friend you in my blog. but I have

微軟研發:制勝策略(實用方法一)

 原文:http://www.blogjava.net/leeguannan/category/29681.html首先還是先看一下書評。下面是來自china-pub的書評:作者詳細描述了他在美國領導項目的各種實際的策略方法,教您如何開發高品質的軟體,而且絕不延誤。本書是為每一位從事研發工作的朋友而寫,相信您在讀過本書之後,一定急於推薦給您的主管、同事和您的朋友。    卓越的領導者從不同的角度看世界。若是公司被大火燒得精光,他非但不為丟飯碗驚慌,反而利用火焰來燒烤一頓大餐。當每個人都搖頭離去,

Win32 調試介面設計與實現淺析

所謂調試器實際上是一個很寬泛的概念,凡是能夠以某種形式監控其他程式執行過程的程式,都可以泛稱為調試器。在Windows平台上,根據調試器的實現原理大概可以將之分為三類:核心態調試器、使用者態調試器和虛擬碼調試器。    核心態調試器直接工作在作業系統核心一級,在硬體與作業系統之間針對系統核心或驅動進行調試,常見的有SoftICE、WinDbg、WDEB386和i386KD等等;使用者態調試器則通過作業系統提供的調試介面,在作業系統和使用者態程式之間針對使用者態程式進行調試,常見的有各種開發環境如

微軟團隊:成功秘訣(1)

原文:http://www.blogjava.net/leeguannan/category/29681.html帶過項目的朋友一定都看過或者聽說過這本書吧,其實這本書是來自“微軟管理經典著作”之中的一本,其他兩本是《微軟項目:求生法則》、《微軟研發:制勝策略》這三本書我會精讀細讀的(雖然我不帶項目~),從中取其精華寫成筆記與大家分享。    首先看一下《微軟團隊:成功秘訣》分別在china-pub和豆瓣上的書評把:china-pub本書敘述了吉姆.麥卡錫帶領微軟Visual C++Team

微軟團隊:成功秘訣(2)

原文:http://www.blogjava.net/leeguannan/category/29681.html法則六:    Watch the ratio    注意人員的組成比例    “基本原則是開發人員和品保人員的比例不超過2:1”這個是作者為我們提出的建議,而在SUN這個比例被修改為1:1,甚至是1:2,可見在項目中品保人員比開發人員更加重要!  

再讀《人月神話》(一)

   初識《人月神話》大概是03年,那個時候知道這是一本關於專案管理方面的好書,所以DOWN了本電子書來看看。說實話當時楞沒看懂,一開始就“焦油坑”,焦油坑跟項目有啥關係,其他的銀彈什麼的也是暈暈乎乎不大明白。最近相對自由時間多一些,準備再溫習一下這本好書。畢竟有了去年過CMM的經驗和一定的專案管理經驗,應該感覺會比較熟悉一些。  

李小龍帶給我們的絕不僅僅是截拳道!

小龍哥經典語錄:       *我絕不會說我是天下第一,可是我也絕不會承認我是第二。       *人,活著的人,創造武術的人要比任何已建立的各種武術體系重要的多,也更有價值。       *修練功夫的目的不是致力於擊破石塊或木板,我們更關心的是用它影響我們的整個思想和生活。       *僅學習某門派某人之機巧,即使發揮至極限,也非真正的搏擊。所謂成熟是指自我最深的覺悟,而非以做觀念上的俘虜。      

利用VB設計列印複雜報表

資料庫管理系統的開發人員經常感歎的一個問題就是:我們中國人的報表太複雜了!無規則、嵌套、斜線、交叉線等曆來都是困撓開發人員的最大問題。設計一個資料庫固然有一定的技巧,設計資料操作也固然需要一定的邏輯分析能力,但這些問題對一般的開發人員來說應該是不成為問題的。使用者可是不管你採用了多麼靈活的演算法多麼方便的操作,他們最感興趣的是最後他們出來的報表如何漂亮,出報表的操作如何簡單(最好是一個按鈕解決所有的問題)。筆者在開發資料庫管理系統方面也稍有些經驗,從FoxPro、Delphi、PowerBuil

開源工具推薦

作為一個軟體開發人員,使用盜版軟體實在是有點搬石頭砸自己的腳。不過作為一個沒有錢的軟體開發人員,還是希望可以使用免費的軟體。 如果您也有我這樣的矛盾心理,就不妨瀏覽一下此網站:http://sourceforge.net/ 一個優秀的開源軟體下載網站。 推薦幾款很好用的工具:1. 7-Zip 一款很好用的壓縮軟體,可以代替Winrar。2. Notepad++  一款十分好用的文本編輯軟體,可以替代UE了。3.

總頁數: 61357 1 .... 14901 14902 14903 14904 14905 .... 61357 Go to: 前往

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.