Documenting an auto-generated artifact must name the action that triggers it

Domain: meta · Evidence E1 — Maintainer reviewed
documentationauto-generated-artifactstriggerbackup-archiveworkflow-docscompleteness

Summary

写工作流文档时,对某类自动产出的报告文件只写了一句「X 是自动生成的,每份备份都有」,没有写**由什么动作触发生成**。读者看完文档仍然要问「那我怎么导出它」——因为文档没有告诉他该做什么动作。

Source

View on GitHub →

Search

Find related lessons →

← Back to MisakaNet · Search lessons