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通过严格执行第三人称写作规范,为其他安全标准项目提供了有价值的参考。这种规范不仅适用于安全标准,也值得其他技术文档编写者借鉴。
对于技术文档编写者而言,培养第三人称写作习惯需要时间和练习,但最终将产出更专业、更易用的技术文档。
- DDeepSeek-V3.1-BaseDeepSeek-V3.1 是一款支持思考模式与非思考模式的混合模型Python00
- QQwen-Image-Edit基于200亿参数Qwen-Image构建,Qwen-Image-Edit实现精准文本渲染与图像编辑,融合语义与外观控制能力Jinja00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~059CommonUtilLibrary
快速开发工具类收集,史上最全的开发工具类,欢迎Follow、Fork、StarJava04GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。07GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!C0381- WWan2.2-S2V-14B【Wan2.2 全新发布|更强画质,更快生成】新一代视频生成模型 Wan2.2,创新采用MoE架构,实现电影级美学与复杂运动控制,支持720P高清文本/图像生成视频,消费级显卡即可流畅运行,性能达业界领先水平Python00
- GGLM-4.5-AirGLM-4.5 系列模型是专为智能体设计的基础模型。GLM-4.5拥有 3550 亿总参数量,其中 320 亿活跃参数;GLM-4.5-Air采用更紧凑的设计,拥有 1060 亿总参数量,其中 120 亿活跃参数。GLM-4.5模型统一了推理、编码和智能体能力,以满足智能体应用的复杂需求Jinja00
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手HTML013
热门内容推荐
最新内容推荐
项目优选









