Non-functional Requirements Documentation in Agile Software Development: Challenges and Solution Proposal
非功能需求（NFR）是软件项目成功的决定性因素。然而，它们的特点是很难定义，在敏捷软件开发（ASD）中，它们通常被赋予较低的优先级，并且通常没有记录。在本文中，我们提出的调查结果的文件的做法和挑战的NFRs在公司利用ASD，并提出指导方针，以提高NFRs的文件在ASD。我们采访了来自四家公司的实践者，并确定了史诗，功能，用户故事，验收标准，完成定义（DoD），产品和sprint backlog用于记录NFRS。请参阅手稿的完整摘要。
2017-11-24 cs.SE
The Role of Executable Abstract Programs in Software Development and Documentation
我们提出了可执行抽象程序，并分析其作用的软件开发和文档。对这些程序的直观理解符合软件系统工程师的计算思维，并得到简单但精确的行为定义的支持。因此，它们可以顺利地集成到从业者的日常工作中，以严格制定从可执行抽象程序到目标和有效运行代码的路径上所采取的每一个设计和实现决策。所得到的系统文档的可执行抽象程序表示可以通过测试（由于其可执行特性）或推理（由于其行为的数学定义）检查和证明的实现步骤的定义。对于复杂的系统，实施涉及多个（正交或连续）的实施步骤，代表一个实际的计算细化概念的实例。这种系统开发过程是由计算改进驱动的，并严格限于明确制定和证明-除了要求-只有必要的实施步骤。其结果是，它产生的副作用是文档的语料库，促进了最终代码的可理解性，提高了其可靠性和弹性;它还增强了维护过程（包括重用和抽象程序和代码的更改），降低了维护成本。
2022-09-14 cs.SE
Automatic Code Documentation Generation Using GPT-3
源代码文档是高效软件开发的重要工件。代码文档可以大大受益于自动化，因为手动文档通常是劳动，资源和时间密集型的。在本文中，我们使用Codex来自动创建代码文档。Codex是一个基于GPT-3的模型，在自然语言和程序设计语言上进行了预训练。我们发现，即使在一次性学习（即，仅提供一个用于训练的示例）。Codex在六种不同的程序设计语言上获得了20.6的BLEU总分（比早期的最先进技术提高了11.2%）。因此，Codex显示了前景，并保证了未来对自动代码文档生成的深入研究，以支持各种开发任务。
2022-09-06 cs.SE
Auto-Documenation for Software Development
软件文档是一项必不可少但劳动密集型的任务，通常需要专门的开发人员团队来确保覆盖范围和准确性。良好的文档将有助于缩短开发周期，提高团队的整体效率和可维护性。在当今的众驱动开发环境中，良好的文档可以在从头开始构建开发人员社区方面发挥很大作用。为此，我们迈出了第一步，构建了一个名为Autodoc的工具，可以帮助软件开发人员更快地编写更好的文档。Autodoc超越了传统的样板模板生成。我们的集成工具使用深度学习方法来构建代码的语义理解。就像自然语言中的机器翻译一样，Autodoc可以将代码片段翻译为注释，并将其作为简短的摘要插入文档字符串中。我们还演示了将Autodoc集成为IDE插件以及在向用户的Git存储库提交自动记录的代码时从软件托管平台中的Web钩子。
2017-01-30 cs.SE
Do we really need to write documentation for a system? CASE tool add-ons: generator+editor for a precise documentation
系统开发项目的一个常见问题是系统文档往往过时，并且没有描述系统的最新版本。如果我们不是在谈论系统的自然语言描述，而是在谈论它的形式化规范，那么情况就更加复杂了。在本文中，我们将讨论如何解决这个问题，自动更新的文档，通过生成一个新的正式规格的模型，如果模型是经常改变。
2014-04-29 cs.SE
Code Documentation and Analysis to Secure Software Development
CoDAT 工具利用大型语言模型和正则表达式算法，在 IDE 中自动检测代码与注释的不一致，支持逐步精化开发，并通过去中心化后端保障代码一致性。
2024-07-16 cs.SE
Evaluating Repository-level Software Documentation via Question Answering and Feature-Driven Development
Harbin Institute of Technology, Shenzhen, China（哈尔滨工业大学（深圳））；Independent Researcher, China（独立研究者）
本文提出SWD-Bench基准，通过功能驱动的问答任务评估仓库级文档质量，揭示现有方法局限，并展示高质量文档对SWE-Agent问题解决率的提升。
2026-04-08 cs.AI cs.SE
Who Writes the Docs in SE 3.0? Agent vs. Human Documentation Pull Requests
Nara Institute of Science and Technology（奈良先端科学技术大学院大学）；University of Calgary（卡尔加里大学）
研究发现 AI 代理在文档拉取请求中比人类更活跃，且其文档修改较少被人类跟进，引发对文档质量和人机协作的担忧。
2026-01-28 cs.SE
Context Rot in AI-Assisted Software Development: Repurposing Documentation Consistency for AI Configuration Artifacts
Singapore Management University（新加坡国立管理学院）；Heidelberg University（海德堡大学）
针对AI编码助手的配置文件（如CLAUDE.md）随软件演化而变得陈旧的问题，提出利用现有文档一致性工具检测上下文腐烂，并在356个仓库中发现23.0%存在过时代码引用。
2026-06-08 cs.AI cs.SE
Doc2Feat-Bench: Evaluating Documentation-Driven Feature Addition
College of Computer Science and Technology and the State Key Laboratory of Blockchain and Data Security, Zhejiang University（浙江大学计算机科学与技术学院和区块链与数据安全全国重点实验室）；Hong Kong University of Science and Technology（香港科技大学）；CISPA Helmholtz Center for Information Security（CISPA赫尔姆霍兹信息安全中心）
本研究构建了Doc2Feat-bench基准及经人工验证的子集，用于评估软件工程智能体基于文档变更实现功能的能力，发现当前最先进智能体在该任务上的最佳成功率仅为37.72%，且面临跨文件编辑等关键挑战。
2026-08-04 cs.SE
Doc2OracLL: Investigating the Impact of Documentation on LLM-based Test Oracle Generation
本研究针对现有研究未深入探究Javadoc注释结合其他上下文对测试预言生成的影响等不足，深入调研Javadoc注释在基于大语言模型的测试预言生成中的作用。
2025-03-25 cs.SE
Bridging the Gap Between Agility and Planning
本文提出一种混合管理框架，通过战略里程碑计划驱动项目执行，保留敏捷开发的经验控制组件，支持灵活的开发方法选择。
2026-03-25 cs.SE
Linking Code and Documentation Churn: Preliminary Analysis
该研究针对代码与文档变更不同步影响项目可维护性的问题，通过分析3个GitHub开源项目，探究二者同步性及文档自动生成可行性，指出LLM等技术可助力同步，以提升开发效率与项目健康度。
2024-10-08 cs.SE
A Preliminary Study for the development of an Early Method for the Measurement in Function Points of a Software Product
Albrecht的功能点分析（FPA）是一种确定软件产品功能规模的方法。国际功能点用户组（IFPUG）制定了FPA作为软件功能规模度量的标准。IFPUG [3] [4]方法遵循Albrecht的方法，并在其扩展版本中对规则和提示进行了修改，旨在改进它[7]。应用该方法所需的文件级别是功能规范，对应于Rudolph分类[8]中的I级。对于那些致力于为第三方开发软件的公司来说，当他们必须为这种开发准备适当的预算时，这些文档是有困难的。然后，我们需要开发一种早期方法[6] [9]来度量软件产品的功能大小，我们将其命名为早期方法或EFPM（早期功能点方法）。应用EFPM所需的文件是用户需求或一些类似的文件。这是奥维耶多大学目前正在进行的一项研究工作的一部分。在这篇文章中，我们只显示了以下结果：从一组项目的测量使用IFPUG方法v.4.1，我们得到的线性相关系数的功能点的总数为每个项目和ILF的数量，ILF + EIF的数量和EI + EO + EQ的数量计数器。使用初步结果，我们计算回归函数。这一结果，我们将使我们能够确定的因素要考虑的发展EFPM和估计的功能点。
2004-02-09 cs.SE
Automatic API Usage Scenario Documentation from Technical Q&A Sites
在线技术问答网站Stack Overflow（SO）在开发人员中很受欢迎，以支持他们的编码和多样化的开发需求。为了解决API官方文档资源中的缺点，一些研究因此集中在用见解来增强官方API文档（例如，代码示例）。这些技术建议将有关API的代码示例/见解添加到其官方文档中。评论是带有积极/消极情绪的固执己见的句子。然而，我们知道以前没有研究试图通过考虑API代码示例和评论来自动从SO生成API文档。在本文中，我们提出了两个新的算法，可用于自动产生API文档从SO结合代码的例子和评论对这些例子。第一种算法被称为统计文档，它使用不同的度量（例如，星级）。第二种算法被称为基于概念的文档，它将相似的和概念上相关的使用场景聚集在一起。API使用场景包含代码示例、由代码示例解决的底层任务的文本描述以及评论（即，意见与积极和消极的情绪）从其他开发人员对代码示例。我们在Opiner中部署了这些算法，Opiner是一个基于Web的平台，可以从在线论坛中聚合有关API的信息。我们通过挖掘SO中所有基于Java JSON的帖子，并根据帖子中生成的文档进行三次用户研究来评估算法。
2021-02-16 cs.SE
Bridging Education and Development: IDEs as Interactive Learning Platforms
本文提出基于IntelliJ IDE与JetBrains Academy Plugin的IDE内课程模式，将理论与实践嵌入专业开发环境，并以40余门多主题课程验证其教学效果。
2024-01-25 cs.SE
Towards evaluating and eliciting high-quality documentation for intelligent systems
IBM Research（IBM研究院）；Rensselaer Polytechnic Institute（伦斯勒理工学院）
建立在机器学习和人工智能基础上的智能系统的信任和透明度的一个重要组成部分是开发清晰、可理解的文档。然而，这样的系统因其复杂性和不透明性而臭名昭著，这使得高质量的文档成为一项重要的任务。此外，人们对是什么让此类文档“好”知之甚少。“在本文中，我们提出并评估了一套质量维度，以确定这种类型的文档在哪些方面存在不足。然后，使用这些尺寸，我们评估三种不同的方法，引起智能系统的文档。我们将展示这些维度如何识别这些文档中的缺点，并说明如何使用这些维度来进一步使用户能够提供适合给定角色或用例的文档。
2020-11-17 cs.AI cs.SE
C2|Q>: A Robust Framework for Bridging Classical and Quantum Software Development -- RCR Report
University of Oulu（奥卢大学）；Wuhan University（武汉大学）；Lappeenranta-Lahti University of Technology（拉彭兰塔-拉赫蒂理工大学）；Aalto University（阿尔托大学）
本文提出一种模块化、硬件无关的框架，将经典问题规范转换为可执行的量子程序，支持多种问题家族和硬件后端。
2026-08-03 cs.SE
CASCADE: Detecting Inconsistencies between Code and Documentation with Automatic Test Generation
Humboldt-Universität zu Berlin（柏林洪堡大学）；XBOW
CASCADE利用大语言模型生成单元测试，通过代码与文档生成的测试结果对比，检测代码与文档不一致问题，验证其在真实代码库中的有效性与精度。
2026-04-21 cs.SE
Collaboration Challenges in Building ML-Enabled Systems: Communication, Documentation, Engineering, and Process
Carnegie Mellon University（卡内基梅隆大学）；University of Toronto（多伦多大学）；Carnegie Mellon Software Engineering Institute（卡内基梅隆软件工程研究所）
在软件项目中引入机器学习（ML）组件，使得软件工程师需要与数据科学家和其他专家合作。虽然协作总是具有挑战性的，但ML在探索性模型开发过程中引入了额外的挑战，需要额外的技能和知识，测试ML系统的困难，需要持续的进化和监控，以及非传统的质量要求，如公平性和可解释性。通过采访来自28个组织的45名从业者，我们确定了团队在构建ML系统并将其部署到生产中时面临的关键协作挑战。我们报告了生产ML系统开发中的常见协作点，以满足需求，数据和集成，以及相应的团队模式和挑战。我们发现，这些挑战大多围绕着沟通、文档、工程和流程，并收集解决这些挑战的建议。
2022-02-10 cs.LG cs.SE
Remember Your Trace: Memory-Guided Long-Horizon Agentic Framework for Consistent and Hierarchical Repository-Level Code Documentation
Sungkyunkwan University（成均馆大学）；University of Oslo（奥斯陆大学）
MemDocAgent通过依赖感知遍历引导和记忆引导代理交互，生成统一上下文的仓库级代码文档，实现高效且一致的文档生成。
2026-09-30 cs.CL cs.SE
Software and System Modeling Based on a Unified Formal Semantics
建模和文档化是软件开发工程原则的两个基本要素。在过去的二十年中，已经提出了各种各样的描述和建模技术以及文档格式。然而，这些通常没有集成到一个连贯的方法中，模型和文档之间有明确的依赖关系。这阻碍了集中的软件开发以及提供强大的工具支持。在本文中，我们提出了一个统一的，正式的软件和系统建模的基础上的主要问题和大纲的解决方案。
2014-11-10 cs.SE
Applying SHAPR in AI-Assisted Research Software Development: Lessons Learnt from Building a Share Trading System
School of Business, Law, Humanities and Pathways University of Southern Queensland（南昆士兰大学商业、法律、人文与路径学院）
本文通过构建模块化股票交易系统案例，展示了SHAPR框架在AI辅助软件开发中的应用，强调持续文档更新、合同稳定编码、源码层提升连贯性等核心方法与贡献。
2026-04-16 cs.HC cs.SE
From Waterfallish Aerospace Certification onto Agile Certifiable Iterations
本文提出一种符合DO-178C标准的持续文档生成策略与工具，通过迭代创建和无缝合并软件组件文档，实现可认证的敏捷迭代，经航空航天业界验证证实了其适用性，促进了敏捷实践在该领域的推广。
2025-03-06 cs.SE
Bridging Behavior and Implementation: Automated Java Glue Code Generation for Behavior-Driven Development
University of Alberta（阿尔伯塔大学）
研究针对行为驱动开发中胶水代码开发维护难题，提出分层多智能体框架AutoGlue，遵循行为优先工作流程。经实验评估，相比少样本提示，其在代码生成指标上有显著提升，能有效连接行为规范与项目代码，支持软件开发。
2026-07-23 cs.SE
Understanding How Programmers Can Use Annotations on Documentation
现代软件开发要求开发人员找到并有效地利用新的API及其文档，但文档有许多众所周知的问题。尽管如此，开发人员最终克服了这些问题，但无法分享他们学到的东西。我们研究通过\textit{annotations}共享此特定于文档的信息，这比开发人员论坛具有优势，因为信息是上下文化的，不具有破坏性，并且简短，因此易于创作。开发人员还可以编写注释来支持自己的理解。为了支持我们发现的文档使用行为，我们构建了Adamite注释工具，它支持多锚定、注释类型和固定等特性。在我们的用户研究中，我们发现开发人员能够创建对自己有用的注释，并且能够在学习新API时利用其他开发人员创建的注释，注释的读者平均比基线多完成67%的任务。
2022-01-11 cs.HC cs.SE
A tool stack for implementing Behaviour-Driven Development in Python Language
本文提出了一种基于Python语言的行为驱动开发（BDD）的软件实现、规范和测试工具栈。此堆栈的使用突出了软件预期行为的规范和验证，降低了出错率并改进了文档。因此，除了更好地服务于涉众的期望之外，还可以在功能和单元级别上产生缺陷更少的代码。
2010-07-10 cs.SE
A Study on the Improvement of Code Generation Quality Using Large Language Models Leveraging Product Documentation
Ibaraki University（茨城大学）
针对现有E2E测试生成研究不足的问题，提出利用定制提示词让LLMs基于产品文档两步生成E2E测试代码的方法，实验证明其效果优于需求规格和用户故事方案，可提升软件质量。
2025-03-22 cs.AI cs.SE
Enhancing API Documentation through BERTopic Modeling and Summarization
École de technologie supérieure（高等技术学院）
针对官方 API 文档冗长且不友好的问题，本文结合 BERTopic 主题建模与 NLP 自动生成文档摘要和主题，并评估其性能、连贯性与互操作性。
2023-08-17 cs.AI cs.CL cs.LG
C2|Q>: A Robust Framework for Bridging Classical and Quantum Software Development
University of Oulu（奥卢大学）；Wuhan University（武汉大学）；Lappeenranta-Lahti University of Technology（拉彭兰塔-拉赫蒂理工大学）；Aalto University（阿尔托大学）
C2|Q>通过模块化方法将经典规范转化为量子可执行程序，降低量子软件开发门槛，实验证明其在模拟和真实量子硬件上均具可靠性。
2026-03-14 cs.SE
Bridging Design and Development with Automated Declarative UI Code Generation
本文提出 DeclarUI，融合 CV、MLLM 与编译器驱动迭代优化，从 UI 设计自动生成声明式代码，在 React Native、Flutter 和 ArkUI 上显著提升覆盖率、视觉相似度与编译成功率。
2024-09-18 cs.SE
AI Observability for Developer Productivity Tools: Bridging Cost Awareness and Code Quality
Northeastern University（东北大学）；Boston University（波士顿大学）
本文提出一种统一的AI可观性方法，通过实时跟踪token、配置模型定价库、响应验证和成本分析，构建单一仪表板，提升开发者生产力工具的成本与代码质量理解。
2026-04-18 cs.SE
From Reflection to Repair: A Scoping Review of Dataset Documentation Tools
Robotics and AI Institute（机器人与人工智能研究所）；Escuela Superior Politécnica del Litoral（海岸理工大学）；IBM Research USA（IBM美国研究）
本文通过综述59篇文献，揭示数据集文档工具设计中的四个阻碍因素，并提出转向机构解决方案以促进可持续文档实践。
2026-02-17 cs.AI cs.CY cs.HC
Development of recommendation systems for software engineering: the CROSSMINER experience
为了执行日常任务，开发人员通过咨询开源软件（OSS）存储库来集中利用现有资源。这样的平台包含丰富的数据源，例如，代码片段、文档和用户讨论，这些对支持开发活动很有用。在过去的几十年里，已经推广了一些技术和工具，为开发人员提供创新功能，旨在提高开发工作量，节省成本和生产力。在欧盟H2020 CROSSMINER项目的背景下，一套建议系统已经被构思出来，以帮助软件程序员在开发过程的不同阶段。这些系统为开发人员提供了各种工件，例如第三方库、有关如何使用所采用的API的文档或相关API函数调用。为拟订这些建议，作出了各种技术选择，以克服与若干方面有关的问题，包括缺乏基线、数据有限、关于业绩计量的决定以及评价方法。本文是一份经验报告，介绍了通过CROSSMINER项目开发的一套推荐系统的相关知识。我们详细解释了我们必须应对的挑战，以及在开发和评估这些系统时学到的相关经验教训。我们的目标是为研究社区提供具体的外卖信息，这些信息预计对那些想要开发或定制自己的推荐系统的人有用。报告的经验，可以促进有趣的讨论和研究工作，这最终有助于推荐系统的进步，应用于解决不同的问题，在软件工程。
2021-03-11 cs.SE
Bridging the Clinical Expertise Gap: Development of a Web-Based Platform for Accessible Time Series Forecasting and Analysis
University of Kentucky（肯塔基大学）
本文提出了一款网页平台，旨在通过提供多种预测模型和定制化功能，使临床研究人员更便捷地进行时间序列预测与分析。
2025-12-08 cs.LG cs.SE
The Introduction of README and CONTRIBUTING Files in Open Source Software Development
本文基于 Debian 打包的 FLOSS 项目数据集，定量分析 README 与 CONTRIBUTING 文件首次引入的时机和内容，发现项目更倾向简洁标准说明而非主动的社区建设文档。
2025-03-14 cs.SE cs.SI
Bridging the Gap on AI-Assisted Scientific Software Development Through Transparency and Traceability
Idaho National Laboratory（爱达荷国家实验室）
本文探讨了在严格软件质量保证背景下如何负责任地使用人工智能辅助科学软件开发，提出了一种结构化框架用于AI辅助的验证与验证案例开发，以确保软件质量。
2026-07-29 cond-mat.mtrl-sci cs.SE
IndicEval-XL: Bridging Linguistic Diversity in Code Generation Across Indic Languages
Deutsche Telekom Digital Labs（德国电信数字实验室）
针对现有代码生成基准以英语为中心的问题，提出IndicEval-XL基准，覆盖6种印度语言和12种编程语言，旨在提升多语言代码生成评估的包容性，并公开数据集以促进研究。
2025-02-26 cs.CL cs.SE
State of the Practice for Medical Imaging Software
McMaster University（麦克马斯特大学）
本文评估29个医学影像项目并访谈8个团队，利用AHP排名软件，揭示其工程实践健康状况、CI与测试不足等痛点，并提出改进建议。
2024-05-20 cs.CV cs.SE
From Agent Behaviour to Agent-Friendly Documentation: An Empirical Study of How Coding Agents Discover, Read, and Write Technical Documentation
Peking University（北京大学）
本研究通过SWE-chat和AIDev两个数据集，揭示编码智能体的文档交互规律，发现面向智能体的制品占主导，文档与代码编辑关联弱，验证序列缺失，文档滞后代码，且"智能体友好型"文档的可操作性、可验证性缺乏行为支持。
2026-08-21 cs.AI cs.HC cs.SE
Bridging the Prototype-Production Gap: A Multi-Agent System for Notebooks Transformation
Siemens AG（西门子股份公司）；Technical University of Munich（慕尼黑工业大学）
本文提出多智能体系统 Codelevate，通过 Architect、Developer 和 Structure 三个智能体协同工作，自动将 Jupyter notebook 转换为结构良好、可维护的 Python 代码仓库，在保留计算语义的同时提升代码质量指标。
2025-11-10 cs.MA cs.SE
CelloAI: Leveraging Large Language Models for HPC Software Development in High Energy Physics
Brookhaven National Laboratory（布鲁克海文国家实验室）；Lawrence Berkeley National Laboratory（伯克利国家实验室）；Argonne National Laboratory（阿贡国家实验室）
CelloAI是一个本地托管的HEP编码助手，结合LLM与RAG技术，通过语法感知分块和调用图知识提升代码文档生成与代码生成的准确性，并在ATLAS、CMS和DUNE实验应用中验证了其有效性。
2025-08-22 cs.AI cs.SE hep-ex
From What to How: Bridging User Requirements with Software Development Using Large Language Models
University of Science and Technology Beijing（北京科技大学）；Hong Kong University of Science and Technology（香港科学大学）；University of Science（科学大学）
本文提出DesBench基准测试，评估LLMs在软件设计相关任务中的表现，揭示LLMs在代码生成、面向对象建模及测试用例设计方面的局限性。
2026-02-14 cs.AI cs.SE
From Safety Documentation to Safety Knowledge Support: An Evidence-Grounded LLM Framework for Medical Devices
Fraunhofer IESE（弗劳恩霍夫IESE研究所）；RPTU Kaiserslautern-Landau（凯撒斯劳滕-兰道莱茵-普法尔茨理工大学）
针对现有LLM在医疗器械安全工程中源链接等支持不足的问题，本文提出基于证据的LLM框架，用于安全知识支持，不做安全判定，还给出对应评估策略。
2026-08-13 cs.AI cs.SE
ReservoirChat: Interactive Documentation Enhanced with LLM and Knowledge Graph for ReservoirPy
Mnemosyne Inria Bordeaux, France（Mnemosyne 国家信息与自动化技术研究院波尔多分校）
本文介绍ReservoirChat，一种结合RAG与知识图谱的交互式文档工具，旨在提升LLM在ReservoirPy代码开发与储层计算问答中的准确性和可靠性，并在编码任务上优于ChatGPT-4o等专有模型。
2025-07-04 cs.AI cs.CL cs.NE
LLM Benchmarking with LLaMA2: Evaluating Code Development Performance Across Multiple Programming Languages
Los Alamos National Laboratory（洛斯阿拉莫斯国家实验室）；Louisiana State University（路易斯安那州立大学）
本文评估Llama 2-70B在科学计算中生成代码、文档、单元测试及翻译代码的能力，发现其处理简单任务尚可，但复杂并行计算需大量人工修正。
2025-05-30 cs.AI cs.LG cs.SE
The State of Generative AI in Software Development: Insights from Literature and a Developer Survey
Bucharest University of Economic Studies（布加勒斯特经济大学）
研究通过文献综述和65名开发者的调查，发现生成式AI在设计、实现、测试和文档中影响最大，显著减少重复性任务时间，但早期SDLC阶段收益较低，需加强治理以应对风险。
2026-03-17 cs.AI cs.CY cs.ET
