内容创作
docs-applying-content-quality avatar

docs-applying-content-quality

标准化 Markdown 内容,包含主动语态、精确的标题层级以及符合 WCAG AA 无障碍标准,适用于文档、网站及仓库文件。

简介

此技能作为 Open Sharia Enterprise 仓库中所有 Markdown 内容的全面质量保证框架。它强制执行专业语调与一致的结构完整性,确保 docs/、网站及项目计划中的文档保持可读性、无障碍性与可维护性。通过强制使用主动语态与明确的标题嵌套规则,消除了模糊性,并改进开发者与相关人员的信息检索效率。

  • 强制执行单一 H1 使用与严格的标题层级嵌套,以确保文档逻辑流畅。

  • 验证无障碍合规性,特别要求图像需具备描述性替代文字 (alt text) 并确保符合 WCAG AA 色彩对比度。

  • 实作内容限制,如段落长度限制(≤5 行)及强制要求代码块指定语言以进行语法高亮。

  • 禁止时间性框架(例如:“这需要 5 分钟”),以防止人为压力并确保内容不分用户经验皆适用。

  • 标准化格式,包括使用粗体而非斜体进行强调,以及使用语义列表来优化屏幕阅读器兼容性。

  • 自动化仓库根目录文件(如 README.md 与 CONTRIBUTING.md)的质量检查,提升项目呈现的专业度。

  • 提供可重复使用的检查清单,用于手动或自动验证,确保每份 Markdown 文件皆符合高质量工程文档标准。

  • 在撰写或审阅技术文档、教程内容或项目计划时,将此技能整合至工作流程中。

  • 确保仓库中包含的所有图表与图像皆符合定义的替代文字与无障碍指南。

  • 使用此技能审核旧有内容,并在发布或重大更新前使其符合目前的仓库标准。

  • 保持段落简洁且无术语堆砌,利用所提供的原则确保内容对不同技术背景的读者皆具可及性。

仓库统计

Star 数
9
Fork 数
1
Open Issue 数
0
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 21:02
在 GitHub 查看