Automatic documentation generation tools, or auto docs, are widely used to visualize information about APIs. However, each auto doc tool comes with its own unique representation of API information. In this paper, I use an information visualization analysis of auto docs to generate potential design principles for improving their usability. Developers use auto docs as a reference by looking up relevant API primitives given partial information, or leads, about its name, type, or behavior. I discuss how auto docs can better support searching and scanning on these leads, e.g. by providing more information-dense visualizations of method signatures.

中文翻译：

---

文档生成作为信息可视化

自动文档生成工具或自动文档被广泛用于可视化有关 API 的信息。但是，每个自动文档工具都有自己独特的 API 信息表示。在本文中，我使用自动文档的信息可视化分析来生成潜在的设计原则，以提高其可用性。开发人员通过在给定部分信息或线索的情况下查找有关 API 原语的名称、类型或行为，从而使用自动文档作为参考。我讨论了自动文档如何更好地支持对这些线索的搜索和扫描，例如通过提供方法签名的更多信息密集可视化。