掃瞄文件不清晰 使文件清晰明了的10個技巧

2021-10-08 04:46:24 字數 1733 閱讀 2556

掃瞄文件不清晰

找乙個好作家的人閱讀並編輯所寫的內容也很有幫助。 我為opensource.com撰寫文章的最喜歡的好處是,我有出色的編輯人員在我的作品上線之前對其進行審查(請閱讀: 為opensource.com做出貢獻的7個主要理由 )。

在澄清文件時,需要尋找以下十件事。

在大多數情況下,您應該首選主動聲音。 可以直接說。 您如何檢查被動語音? 插入單詞「 by zombies 」。 例如,說「如果單擊'是',將刪除您的資料」,而不是「如果單擊'是',將刪除資料」。 將殭屍測試應用於以下兩個示例:

在第乙個示例中,毫無疑問您是演員。 第二個示例表明存在誤解的空間。 非常清楚地指出哪些演員在執行動作。

有些術語是不可避免的,但為清楚起見,應盡可能避免使用。 第一次使用時,鏈結到術語的定義是可以接受的,並且還應該編寫自己的簡要定義。 您不想依靠外部站點的可用性,或者不想讓您的讀者無數次地了解您的文件。

質疑所有您認為自己知道的事物,並利用指尖觸及的世界來查詢所有事物。 例如,「 eg」表示「例如」,而「 ie」表示「換句話說」。 「效果」是名詞(如xkcd所示, 除非是 , 否則為名詞),「效果」是動詞。 當可以從句子中刪除乙個子句而不改變其含義時,請使用「 that」;如果不能,則使用「 that」。

當不清楚某個單詞或短語正在修改哪個物件時,就建立了乙個懸空修改器 。 乙個典型的例子是「餓了,剩下的食物被吞噬了」。 餓是食物的名字嗎? 如果您的意思是在「食物」之後新增逗號。 如果不是,請將其重寫以使您的意思清楚:「您的作者餓了,吞噬了剩下的食物。」 仔細組織句子; 不要強迫讀者猜測你的意思。

如果您的專案或公司有文件的樣式指南,請檢查所寫內容是否符合該指南。 乙個常見的錯誤是公司和專案名稱的縮寫。

您知道在撰寫本文時刪除了「經常」和「一些」之類的詞的次數嗎? 我不知道確切多少,但我知道這是乙個非零的數字。 使用具有特定含義的詞。 當您試圖說服讀者您告訴他們的內容很重要時,這尤其重要。 如果我說「遵循這些技巧可以使您的寫作更好」,那麼它的說服力就不如「遵循這些技巧將使您的專案的財務貢獻增加45%」。 如果您使用模糊的單詞來捉住自己,請問問自己您是否真的了解自己的主題,或者是否正在嘗試隱藏某些東西。

英語沒有用於修飾名詞的形式定義的排序結構,但是matthew anderson在此推文中描述了一種非正式的結構:觀點大小年齡形狀顏色起源材料用途名詞。 這是說英語的母語人士知道的,但不知道我們知道的。 彼得·索科洛夫斯基( peter sokolowski)提出建議, 將「 nounier」詞放得更靠近名詞 。 如果這樣做沒有幫助,您可以閱讀對他的答覆的討論,其中包含許多示例和解釋。

技術並不像我們想像的那樣簡單。 如果您告訴讀者一些簡單的事情然後他們做不到,那麼他們會怎麼想呢? 除非您要為最新的必備廚房小工具編寫資訊電視,否則請不要使用這些文字。

當您說「我們」時,您真正的意思是誰? 我看過以所謂的「烹飪表演風格」編寫的文件,其中「接下來,我們單擊whatchamadoozit來使搖搖晃晃的東西搖搖欲墜」。 在支援環境中寫作時,弄清誰在做什麼尤為重要。 如果您告訴某人「我們可以更改該設定」,那麼他們希望您會為他們做,而不是他們可以在您的指導下完成。 作為一般規則,除非我談論自己是作者或代表的組織,否則請避免使用第一人稱(i / we)。 如有疑問,請用第三人稱自己(例如「作者建議您用第三人稱自己」)。 聽起來可能過於正式,但很明顯。

不要在「 to」和動詞之間插入單詞。 您的文件的使命是大膽嘗試以前沒有做過的文件。 (星艦船長被免除此規則)。

您還有其他喜歡的技巧嗎?

翻譯自:

掃瞄文件不清晰

react Context的使用,清晰明了

context 提供了乙個無需為每層元件手動新增 props,就能在元件樹間進行資料傳遞的方法。在乙個典型的 react 應用中,資料是通過 props 屬性自上而下 由父及子 進行傳遞的,但這種做法對於某些型別的屬性而言是極其繁瑣的 例如 地區偏好,ui 主題 這些屬性是應用程式中許多元件都需要的...

清晰解析什麼是文件流?

所謂的文件流,就好比如一塊塊的正方形組成的乙個整體,而這些正方形就代表著每個div。當某個div脫離了這個整體,也就代表他脫離了文件流。然後下乙個div就會來填補脫離的div的位置。下面是流程圖。有四個小朋友在買小賣部排隊買糖吃 第乙個買完了糖的小朋友脫離了排隊的隊伍開心的吃糖去。後面的小朋友看前面...

如何讀取不清晰的條碼?

多話不說,見下圖 這是halcon示例程式中有的圖,一般正常情況下,是讀不出來的。碰到這樣的圖怎麼辦?解決辦法 1 通過畫素直方圖提取其黑色條區域 2 生成一幅新圖 3 將提取黑色條區域重新生成一幅圖。4 讀取條碼值就可以實現。原 如下 dev close window read image ima...