SheepNav
QUALITY.md

QUALITY.md

qualitymd.com

持续提升质量,而非修复混乱。

15天前制作者:Craig Smitham

关于 QUALITY.md

QUALITY.md 是一个开放格式,旨在帮助人类和智能体维护并持续改进其交付、运营和维护的系统质量。它通过让关注、对齐和关怀最重要的事情变得更容易,来实现这一目标。

核心功能

QUALITY.md 的核心是一个包含质量模型的 YAML 前置元数据。该模型定义了质量特性(如安全性、可访问性、测试质量等)及其对应的质量要求(文档、指南、传感器等)。Markdown 正文则提供了这些特性为何重要的上下文。

主要特性

  • 开放格式:基于 YAML 和 Markdown,易于阅读、编辑和版本控制。
  • 质量模型驱动:明确列出关键质量特性及其要求,确保团队对齐。
  • 上下文丰富:在 Markdown 正文中解释每个质量特性的重要性,促进理解。
  • 人机友好:既适合人类阅读和协作,也便于 AI 代理解析和操作。
  • 持续改进:鼓励定期审查和更新,使质量成为持续过程而非一次性任务。

适用场景

QUALITY.md 适用于任何需要系统化质量管理的团队,尤其是 DevOps、平台工程和 AI 代理开发团队。它可作为项目根目录下的标准文件,与 README.md、CONTRIBUTING.md 等互补,帮助团队从一开始就建立质量文化,避免后期返工。

相关工具