论文标题
文档生成作为信息可视化
Documentation Generation as Information Visualization
论文作者
论文摘要
自动文档生成工具或自动文档被广泛用于可视化有关API的信息。但是，每个自动DOC工具都有其自己独特的API信息表示。在本文中，我使用自动文档的信息可视化分析来生成潜在的设计原理以提高其可用性。开发人员通过查找有关其名称，类型或行为的部分信息或引线的相关API原语，将自动文档作为参考。我讨论了自动文档如何更好地支持这些线索上的搜索和扫描，例如通过提供方法签名的更多信息密集的可视化。
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.
