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

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

2025-06-27 08:50:25作者:胡唯隽

在软件安全标准文档的编写过程中,保持专业、客观的写作风格至关重要。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通过严格执行第三人称写作规范,为其他安全标准项目提供了有价值的参考。这种规范不仅适用于安全标准,也值得其他技术文档编写者借鉴。

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

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
52
461
kernelkernel
deepin linux kernel
C
22
5
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
349
381
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
131
185
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
873
517
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
336
1.09 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
179
264
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
608
59
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4