Metasploit/风格指南

使用截图时，请保持截图“干净”且非促销性质。技术作家倾向于插入其公司网站或研究小组横幅的截图。为了保持一致性，尽量保持所有截图无聊且通用。

使用截图时，尽量对所有截图使用浅色背景和深色文字。它看起来不像那么厉害，但是如果有人决定打印内容，它使用的墨水要少得多。

使用任何图形时，请记住浅色不会很好地打印。避免在白色背景上使用黄色，并且尽量不要在描述或其他图标可以满足的情况下对屏幕元素进行颜色编码。如果你谈论绿色按钮如何执行一项操作，而其他按钮执行另一项操作，当读者用黑白打印时，他们会感到非常困惑。一些读者是色盲，他们也无法理解这些参考。

截图不能替代详细解释，但无需描述截图中的每个元素。

写作时，假设你正在与读者进行现实生活中的合作。使用“我们”来代表你自己和读者。例如，“现在缓冲区已创建，我们可以使用此方法插入我们的返回地址”。不要使用“我们”来代表你自己和合著者。

始终使用现在时和主动语态。例如，写“使用ENCODER选项指定特定的负载编码器”，不要写“ENCODER选项用于指定特定的负载编码器”。

避免使用俚语和脏话。一些用户不像你那么酷，可能不理解。更糟的是，他们可能会被冒犯。

避免使用长词和长句子。如果在一个句子中使用了超过3个逗号，请考虑用更短的方式来表达相同的意思。尽量保持段落简短。每段超过两句话，但不要超过半页长。