首页
/ OWASP ASVS 5.0版本中第三人称写作规范的技术解析

OWASP ASVS 5.0版本中第三人称写作规范的技术解析

2025-06-27 07:21:16作者:胡唯隽

在软件安全标准文档的编写过程中,保持专业、客观的写作风格至关重要。OWASP应用安全验证标准(ASVS)项目组在5.0版本的开发过程中,特别强调了文档内容的第三人称写作规范要求。

背景与重要性

技术标准文档需要保持客观性和普适性,避免使用第一人称("I"、"we")和第二人称("you")等主观表述。这种写作规范能够确保文档内容:

  • 适用于更广泛的读者群体
  • 减少个人主观色彩
  • 提高专业性和权威性
  • 便于翻译和本地化

具体规范要求

ASVS 5.0版本明确规定,除前言部分外,所有内容必须采用第三人称视角进行描述。这意味着需要避免使用以下表达方式:

  • 第一人称:如"we believe"、"our team"等
  • 第二人称:如"you should"、"your application"等
  • 其他主观性表述

实施过程中的发现

在项目审查过程中,发现了一些需要修改的典型例子:

  1. 第一人称使用案例: 原句:"Whilst preparing version 5.0... we didn't want to include..." 修改建议:可改为"During the preparation of version 5.0... the team decided not to include..."

  2. 第二人称使用案例: 原句:"For example, when you log into Google..." 修改建议:可改为"例如,当用户登录Google时..."

  3. 建议性表述案例: 原句:"Designing cryptography as you go..." 修改建议:可改为"在开发过程中临时设计加密方案..."

技术写作最佳实践

基于ASVS项目的经验,总结出以下技术文档写作建议:

  1. 使用被动语态: "Tests should be performed"而非"You should perform tests"

  2. 采用客观描述: "The system must"而非"We require the system to"

  3. 避免直接对话语气: "Developers need to consider"而非"You need to consider"

  4. 保持一致性: 整个文档采用统一的写作风格和术语

对项目的影响

实施严格的第三人称写作规范对ASVS项目产生了积极影响:

  • 提高了文档的专业水准
  • 增强了标准的普适性
  • 为后续版本奠定了良好的写作基础
  • 便于自动化工具检查和维护一致性

结论

技术标准文档的写作规范看似是形式问题,实则直接影响文档的质量和可用性。ASVS 5.0通过严格执行第三人称写作规范,为其他安全标准项目提供了有价值的参考。这种规范不仅适用于安全标准,也值得其他技术文档编写者借鉴。

对于技术文档编写者而言,培养第三人称写作习惯需要时间和练习,但最终将产出更专业、更易用的技术文档。

登录后查看全文

热门内容推荐

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
118
207
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
527
404
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
63
145
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
391
37
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
251
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
297
1.02 K
arkanalyzerarkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
42
40
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
357
341
CangjieMagicCangjieMagic
基于仓颉编程语言构建的 LLM Agent 开发框架,其主要特点包括:Agent DSL、支持 MCP 协议,支持模块化调用,支持任务智能规划。
Cangjie
583
41