READMEs的风格与实质： linting方法
Linting Style and Substance in READMEs
AI总结：
本文通过设计探针LintMe，探索如何利用linting改进READMEs，兼顾不同场景下的风格和内容问题，提供可扩展的检查方法，提升文档质量。
摘要：
READMEs塑造了软件项目的初次印象，但什么是好的README因受众和情境而异。研究软件需要可重复性细节，而开源库可能更注重快速入门指南。通过设计探针LintMe，我们探索如何利用linting改进READMEs，以应对这些多样化的情境，帮助解决风格和内容问题，同时保持作者的自主权。用户使用轻量级的DSL创建上下文特定的检查，结合程序化操作（如检查断裂链接）与基于LLM的内容评估（如检测术语），产生难以被先前linters处理的检查。通过用户研究（N=11）、与朴素LLM使用比较及可扩展性案例研究，我们发现我们的设计具有可接近性、灵活性，并且与该领域的需求高度匹配。这项工作为linting更复杂的文档和其他文化调解的文本文档打开了大门。
英文摘要：
READMEs shape first impressions of software projects, yet what constitutes a good README varies across audiences and contexts. Research software needs reproducibility details, while open-source libraries might prioritize quick-start guides. Through a design probe, LintMe, we explore how linting can be used to improve READMEs given these diverse contexts, aiding style and content issues while preserving authorial agency. Users create context-specific checks using a lightweight DSL that uses a novel combination of programmatic operations (e.g., for broken links) with LLM-based content evaluation (e.g., for detecting jargon), yielding checks that would be challenging for prior linters. Through a user study (N=11), comparison with naive LLM usage, and an extensibility case study, we find that our design is approachable, flexible, and well matched with the needs of this domain. This work opens the door for linting more complex documentation and other culturally mediated text-based documents.
机构、总结、中文摘要均由AI分析而来，可能存在错误，请以论文正文为准。
