iap 審核 文件
如果您向一群人詢問好的文件的質量，您可能會得到許多不同的答案，但是準確性和易讀性應該在每個人的清單上都很高。 您的文件很可能100％準確，並且在發布之日就非常容易閱讀，但是隨著它們描述的產品的發展，它們的價值必然會減少。
是的，即使文件變老了。 如果您的內容發生這種情況，那麼該進行文件審核了。
審核文件通常涉及：
花時間進行仔細的審查和重寫，使您能夠查詢和修復文件不再起作用的位置。 根據我的經驗，我估計審核一章需要一到兩天不間斷的寫作時間（不包括隨後的sme和同行評審）。 時間的長短取決於諸如章節多長，需要多少額外的研究和測試，從技術角度來看內容有多過時以及作者進行此類重寫的經驗。
一兩天聽起來很耗時間-您甚至可能認為這遠遠超出了您的承受能力。 或者，也許您想進行文件審核，但您的老闆不認為這是「實際工作」，因為它不會產生新的輸出。 好訊息是，有許多方法可以證明值得進行全面審查。
確定文件是否準確似乎很簡單。 如果有關產品的資訊正確地描述了產品的行為，則該資訊是準確的。 如果您可以成功遵循說明，則它們是正確的。
由文辭包或類似**提供的命令readable.io 。
當我使用read.io比較審核前後幾章的可讀性資料時，我得到了驚人的結果。
對於產品概述一章，這兩個版本之間的區別最為明顯，該章描述了產品的目標，優勢和元件。 本章僅提供一般概念說明，不提供任何過程。
之前 後
flesch-kincaid grade level
10.4
10.2
flesch reading ease
42.8
41.3
sentences > 30 syllables
106
39 reading time
18:05
8:02
word count
4,069
1,811
預計閱讀時間驚人地減少（從18分鐘減少到八分鐘）是因為減少了絨毛而沒有憐憫並消除了很多重複的文字。 對於介紹性的章節，可以僅描述基礎知識，也可以鏈結到其他章節或指南以獲取更多詳細資訊。
在另一次審核中，這一次是在程式勝於概念描述的章節中，閱讀時間的減少意義不大。 儘管如此，擺脫句子中的絨毛仍然有助於使其更易於閱讀。
之前 後
flesch-kincaid grade level
6.3
5.2
flesch reading ease
67.6
72.5
sentences > 30 syllables
49 20
reading time
14:16
11:34
word count
3,211
2,606
我不得不多次證明審計的優點，例如當我編寫三本大型指南時。 我花了很多時間來重寫已經存在的東西是否值得，尤其是當我們要覆蓋這麼多新產品功能，需要寫很多新內容時，我就陷入了爭論。
我相信上面的比較前後證明是值得的。 經審核的內容不僅對讀者更友好； 因為它通常更短，所以對於作者而言通常更容易維護。
翻譯自:iap 審核 文件
為什麼谷歌必須掌控現實世界？
梳著馬尾辮的阿斯特羅 泰勒是google的帶頭科學家，外人眼中的他是一名為google將數字世界的科技搬到現實世界的瘋狂科學家。他運營著google的準機密研究實驗室google x。google這家搜尋和郵箱服務提供商公司正從它的主營業務中借鑑經驗，以開發這些專案。但是今天泰勒在舊金山一場盛會上解...
為什麼必須首先做規模估計
這個問題客戶問過我，我也解答過多次，但是我一直沒有更直接的理由說服我自己，認為必須先做規模估計再做工作量估計。比如 對維護類的專案，或者是維護類的活動，為什麼要估計規模呢？專案組的人沒有技術風險，對需求很熟悉。我總結了如下的理由 1 以規模來估計工作量與成本 2 規模估計與實現的人與技術無關，比較客...
為什麼重寫equals必須重寫hashCode呢
在理解這個問題時，我認為最先理解的應該是為什麼會重寫equals呢？理解清楚這個的前提下才有必要去理解為什麼需要去重寫hashcode！為什麼需要重寫equals方法呢？我認為是為了適應業務場景的需求而需要對類的equals方法進行重寫，最經典的重寫equals方法的例子莫過於string類了，在o...