📚 内部开发文档目录

重要提示: 本文件夹存放项目的内部开发文档、配置指南、部署说明等，不会被构建到网站中。

📋 文件夹用途

此文件夹用于存放：

1. ✅ 开发配置文档 - 如双构建配置说明
2. ✅ 部署指南 - 服务器部署、Nginx配置等
3. ✅ 开发流程说明 - 工作流程、最佳实践等
4. ✅ 技术架构文档 - 系统架构、技术选型说明
5. ✅ 故障排查指南 - 常见问题解决方案
6. ✅ 更新日志 - 重要的配置变更记录

⚠️ 注意事项

文件命名规范

• 使用清晰的中文或英文文件名
• 建议格式：功能名称-说明.md 或 FUNCTION_NAME.md
• 例如：
  • 双构建部署指南.md 或 DUAL_BUILD_DEPLOYMENT.md
  • Nginx配置说明.md 或 NGINX_CONFIGURATION.md
  • 故障排查.md 或 TROUBLESHOOTING.md

构建排除配置

此文件夹已在构建配置中排除，确保不会出现在网站中：

// .vitepress/config-cn.ts 和 config-en.ts
srcExclude: [
  'docs-internal/**',  // 排除内部开发文档
  // ...
]

📂 当前文档列表

文档	说明	更新时间	类型
README.md	📚 完整指南 - 文件夹用途和AI编写指引	2025-01-10	说明
00-文件夹说明.md	🎯 快速了解 - 文件夹简要说明（优先阅读）	2025-01-10	说明
配置完成总结.md	✅ 双构建配置完成总结	2025-01-10	配置
DUAL_BUILD_DEPLOYMENT.md	🌐 完整部署指南（含Nginx配置）	2025-01-10	部署
QUICK_START.md	🚀 快速开始指南（1分钟上手）	2025-01-10	入门
文档编写规范.md	📝 内部文档的编写规范和模板	2025-01-10	规范
常见问题排查.md	🐛 常见问题和解决方案	2025-01-10	故障排查

文档更新记录

• 2025-01-10: 创建 docs-internal/ 文件夹，迁移双构建相关文档
• 2025-01-10: 添加常见问题排查文档

🤖 AI 助手指引

当需要创建项目相关的开发文档、配置说明、部署指南时，请遵循以下原则：

1. 文档类型判断

应该放在 docs-internal/ 的文档：

• ❌ 不应出现在网站上的内容
• ✅ 开发配置说明（如本次的双构建配置）
• ✅ 服务器部署指南
• ✅ 技术架构文档
• ✅ 开发环境设置
• ✅ CI/CD 配置说明
• ✅ API 内部文档
• ✅ 数据库设计文档
• ✅ 故障排查手册

应该放在网站内容目录的文档：

• ✅ 用户面向的文档（放在 /docs/ 或 /en/docs/）
• ✅ 软件使用教程
• ✅ 功能说明
• ✅ 用户FAQ
• ✅ 博客文章
• ✅ 产品介绍

2. 创建文档流程

# 1. 在 docs-internal/ 中创建文档
docs-internal/新功能配置说明.md

# 2. 更新 docs-internal/README.md 的文档列表

# 3. 确认 srcExclude 配置包含 docs-internal/**

3. 文档模板

创建新文档时，建议包含以下结构：

# 文档标题

## 📋 概述
简要说明文档内容和目的

## 🎯 适用场景
说明何时需要阅读此文档

## 📝 详细内容
具体的配置、步骤或说明

## ⚠️ 注意事项
重要提示和常见陷阱

## 🔗 相关资源
相关文档链接

---
**最后更新**: YYYY-MM-DD
**维护者**: 开发团队

4. 不要创建的文档

禁止在 docs-internal/ 创建：

• ❌ 密码、密钥等敏感信息（应使用 .env 或密钥管理系统）
• ❌ 用户面向的帮助文档（应放在 /docs/ 中）
• ❌ 营销类内容（应放在 /blog/ 中）

📞 维护说明

• 谁维护: 开发团队
• 更新频率: 每次重大配置变更时
• 文档审查: 定期检查文档是否过时

🔄 文档生命周期

1. 创建 - 新功能、新配置时创建文档
2. 更新 - 配置变更时及时更新
3. 归档 - 过时的文档移至 docs-internal/archive/
4. 删除 - 完全不再使用的技术可删除对应文档

---

创建时间: 2025-01-10
维护团队: 开发团队