NVDA项目中的SCons清理操作与用户文档管理

在NVDA开源屏幕阅读器项目中，开发者在执行SCons清理命令时可能会遇到用户文档被意外删除的情况。本文将深入分析这一现象的技术背景和解决方案。

现象描述

当开发者在NVDA项目根目录下执行scons -c命令时，系统会清理构建过程中生成的临时文件。然而，一些开发者发现这个操作会删除user_docs目录下的多个.md格式的用户文档文件，包括各种语言版本的变更记录和用户指南。

技术背景分析

这一现象实际上符合SCons构建系统的预期行为。在NVDA项目中，.md格式的用户文档是通过XLIFF翻译文件自动生成的构建产物，而非原始源文件。项目仓库中保留的.md文件实际上是历史遗留的旧版本文件，这导致了开发者的困惑。

解决方案

正确的处理方式是：

1. 从版本控制中移除所有有对应XLIFF文件的.md文档
2. 确保这些文档只作为构建产物存在，而不纳入版本控制
3. 开发者可以通过Git命令恢复被删除的文件，但长期解决方案是更新项目结构

最佳实践建议

1. 在执行清理操作前，确保所有重要修改已提交
2. 了解项目中哪些文件是构建产物，哪些是源文件
3. 定期同步项目文档结构变更
4. 对于翻译工作，应优先编辑XLIFF文件而非直接修改生成的.md文件

这一改进有助于简化项目结构，减少版本控制中的冗余文件，并确保所有翻译文档都来自统一的XLIFF源文件。