OWASP ASVS 5.0版本中第三人称写作规范的技术解析
在软件安全标准文档的编写过程中,保持专业、客观的写作风格至关重要。OWASP应用安全验证标准(ASVS)项目组在5.0版本的开发过程中,特别强调了文档内容的第三人称写作规范要求。
背景与重要性
技术标准文档需要保持客观性和普适性,避免使用第一人称("I"、"we")和第二人称("you")等主观表述。这种写作规范能够确保文档内容:
- 适用于更广泛的读者群体
- 减少个人主观色彩
- 提高专业性和权威性
- 便于翻译和本地化
具体规范要求
ASVS 5.0版本明确规定,除前言部分外,所有内容必须采用第三人称视角进行描述。这意味着需要避免使用以下表达方式:
- 第一人称:如"we believe"、"our team"等
- 第二人称:如"you should"、"your application"等
- 其他主观性表述
实施过程中的发现
在项目审查过程中,发现了一些需要修改的典型例子:
-
第一人称使用案例: 原句:"Whilst preparing version 5.0... we didn't want to include..." 修改建议:可改为"During the preparation of version 5.0... the team decided not to include..."
-
第二人称使用案例: 原句:"For example, when you log into Google..." 修改建议:可改为"例如,当用户登录Google时..."
-
建议性表述案例: 原句:"Designing cryptography as you go..." 修改建议:可改为"在开发过程中临时设计加密方案..."
技术写作最佳实践
基于ASVS项目的经验,总结出以下技术文档写作建议:
-
使用被动语态: "Tests should be performed"而非"You should perform tests"
-
采用客观描述: "The system must"而非"We require the system to"
-
避免直接对话语气: "Developers need to consider"而非"You need to consider"
-
保持一致性: 整个文档采用统一的写作风格和术语
对项目的影响
实施严格的第三人称写作规范对ASVS项目产生了积极影响:
- 提高了文档的专业水准
- 增强了标准的普适性
- 为后续版本奠定了良好的写作基础
- 便于自动化工具检查和维护一致性
结论
技术标准文档的写作规范看似是形式问题,实则直接影响文档的质量和可用性。ASVS 5.0通过严格执行第三人称写作规范,为其他安全标准项目提供了有价值的参考。这种规范不仅适用于安全标准,也值得其他技术文档编写者借鉴。
对于技术文档编写者而言,培养第三人称写作习惯需要时间和练习,但最终将产出更专业、更易用的技术文档。
cherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端TypeScript037RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统Vue0404arkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架TypeScript040GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。02CS-Books
🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~01openGauss-server
openGauss kernel ~ openGauss is an open source relational database management systemC++0145
热门内容推荐
最新内容推荐
项目优选









