项目介绍

文件名	常见用途
README.md	项目入口说明：项目是什么、如何安装、如何使用
OVERVIEW.md	项目整体概览、模块划分、核心能力
GETTING_STARTED.md	新手快速开始教程
INSTALL.md / INSTALLATION.md	安装步骤、环境要求、依赖配置
USAGE.md	详细使用方法和示例
QUICKSTART.md	最短路径运行项目
TUTORIAL.md	系统化教程
FAQ.md	常见问题与回答
TROUBLESHOOTING.md	故障排查方法
CONFIGURATION.md / CONFIG.md	配置项、环境变量、配置文件说明
ARCHITECTURE.md	系统架构、模块关系、技术设计
DESIGN.md	设计方案、关键决策、实现思路
SPEC.md / SPECIFICATION.md	功能规范、协议或接口定义
API.md / API_REFERENCE.md	API 接口文档
DATABASE.md	数据库结构、表关系、迁移方式
SECURITY.md	安全策略、漏洞报告方式
PERFORMANCE.md	性能指标、优化方案、压测结果
DEPLOYMENT.md	部署流程、服务器或云平台配置
OPERATIONS.md / RUNBOOK.md	日常运维、监控、故障恢复步骤
DEVELOPMENT.md	本地开发环境、调试方式、开发流程
CONTRIBUTING.md	如何参与贡献、提交代码和 PR
CODE_OF_CONDUCT.md	社区行为准则
STYLE_GUIDE.md	编码、文档或 UI 风格规范
TESTING.md	测试策略、运行测试的方法
CHANGELOG.md	每个版本的变更记录
RELEASES.md / RELEASE.md	版本发布流程或发布说明
ROADMAP.md	未来规划和功能路线图
TODO.md	待完成事项
MIGRATION.md / UPGRADING.md	升级或版本迁移指南
COMPATIBILITY.md	兼容的平台、版本、浏览器等
LICENSE.md / LICENSE	软件许可证
AUTHORS.md / CONTRIBUTORS.md	作者和贡献者名单
ACKNOWLEDGEMENTS.md	致谢、第三方项目声明
GOVERNANCE.md	项目治理和决策机制
SUPPORT.md	获取帮助、联系维护者的方式
MAINTAINERS.md	维护者和职责范围
DECISIONS.md	重要技术决策记录
ADR/*.md	Architecture Decision Records，逐条记录架构决策