SuperAPI AI 工具集

playwright-documentation-tests

测试与质量

查看项目

更新于 10-16 09:13

技能介绍

用途

playwright-documentation-tests 是一个面向 Playwright 自动化测试套件的文档编写技能,目标是改善现有 Playwright 代码的可读性。当 Codex 需要为测试套件添加或改进人类可读的注释、文档块(docblock)或文件级说明时,可以使用该技能。

主要能力

该技能围绕“为已有 Playwright 代码补充文档”这一任务展开,覆盖文件、套件、测试、fixture 或辅助函数等不同层级的文档编写。它不负责编写或修改测试逻辑本身,而是聚焦于注释与文档块的质量和位置。

使用方式

技能定义了明确的工作流程:

  1. 首先阅读目标测试文件或支持模块。
  2. 识别哪些位置的注释能够切实帮助未来的维护者。
  3. 在文件、套件、测试、fixture 或辅助函数等合适层级添加简洁文档。

注释规则包括:

  • 优先使用高信息量的文档块,而非逐行叙述。
  • 解释意图、范围或非显而易见的行为。
  • 不重复测试标题或方法名已经明确表达的内容。
  • 避免在简单直接的测试中堆砌注释。

输出

编辑完成后,技能要求进行总结,内容包括:

  • 记录了哪些内容;
  • 这些位置为何重要;
  • 套件中仍然难以理解、可能需要重构而非继续添加注释的部分。

适用场景

适用于已有 Playwright 测试套件需要提升可维护性和可读性的情况,尤其是当测试文件、支持模块、fixture 或辅助函数缺少说明,或注释质量不高、无法帮助后续维护者理解意图时。

限制

资料未提供该技能的具体安装命令、支持的平台、收费方式或价格信息,这些内容暂未提供。该技能聚焦于文档编写,不涉及测试逻辑的生成或重构执行。