Metasploit/風格指南

使用截圖時，請保持截圖“乾淨”且非促銷性質。技術作家傾向於插入其公司網站或研究小組橫幅的截圖。為了保持一致性，儘量保持所有截圖無聊且通用。

使用截圖時，儘量對所有截圖使用淺色背景和深色文字。它看起來不像那麼厲害，但是如果有人決定列印內容，它使用的墨水要少得多。

使用任何圖形時，請記住淺色不會很好地列印。避免在白色背景上使用黃色，並且儘量不要在描述或其他圖示可以滿足的情況下對螢幕元素進行顏色編碼。如果你談論綠色按鈕如何執行一項操作，而其他按鈕執行另一項操作，當讀者用黑白列印時，他們會感到非常困惑。一些讀者是色盲，他們也無法理解這些參考。

截圖不能替代詳細解釋，但無需描述截圖中的每個元素。

寫作時，假設你正在與讀者進行現實生活中的合作。使用“我們”來代表你自己和讀者。例如，“現在緩衝區已建立，我們可以使用此方法插入我們的返回地址”。不要使用“我們”來代表你自己和合著者。

始終使用現在時和主動語態。例如，寫“使用ENCODER選項指定特定的負載編碼器”，不要寫“ENCODER選項用於指定特定的負載編碼器”。

避免使用俚語和髒話。一些使用者不像你那麼酷，可能不理解。更糟的是，他們可能會被冒犯。

避免使用長詞和長句子。如果在一個句子中使用了超過3個逗號，請考慮用更短的方式來表達相同的意思。儘量保持段落簡短。每段超過兩句話，但不要超過半頁長。