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通过严格执行第三人称写作规范,为其他安全标准项目提供了有价值的参考。这种规范不仅适用于安全标准,也值得其他技术文档编写者借鉴。
对于技术文档编写者而言,培养第三人称写作习惯需要时间和练习,但最终将产出更专业、更易用的技术文档。
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0153- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
LongCat-Video-Avatar-1.5最新开源LongCat-Video-Avatar 1.5 版本,这是一款经过升级的开源框架,专注于音频驱动人物视频生成的极致实证优化与生产级就绪能力。该版本在 LongCat-Video 基础模型之上构建,可生成高度稳定的商用级虚拟人视频,支持音频-文本转视频(AT2V)、音频-文本-图像转视频(ATI2V)以及视频续播等原生任务,并能无缝兼容单流与多流音频输入。00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0112