Back to Details

ensure-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Ensure Documentation Coverage

确保文档覆盖率

Verify documentation coverage across a codebase, report gaps, and generate missing docs with parallel language-specific agents.
验证整个代码库的文档覆盖率，报告缺口，并通过并行的特定语言Agent生成缺失的文档。

Workflow

工作流程

  1. Detect languages present in the target codebase.
  2. Review the detailed workflow and standards in 
    references/workflow.md
    .
  3. Spawn parallel verification agents for each detected language.
  4. Consolidate findings into a single report.
  5. Offer interactive generation for any gaps the user wants to fix.
  6. Verify generated docs with the appropriate linters.
  1. 检测目标代码库中存在的语言。
  2. 查看
    references/workflow.md
    中的详细工作流程和标准。
  3. 为每种检测到的语言启动并行验证Agent。
  4. 将结果整合为一份单一报告。
  5. 为用户想要修复的任何缺口提供交互式生成功能。
  6. 使用相应的Linter验证生成的文档。

Notes

注意事项

  • Use 
    --report-only
    to skip generation.
  • Avoid test files unless they are test helpers.
  • Keep report output aligned with the language-specific standards in the reference file.
  • 使用
    --report-only
    参数跳过生成步骤。
  • 除非是测试辅助文件，否则忽略测试文件。
  • 确保报告输出符合参考文件中的特定语言标准。