📁 docs-internal 文件夹说明

🎯 文件夹用途

这个文件夹专门用于存放项目内部的开发文档，这些文档：

• ✅ 不会被构建到网站中（已在配置中排除）
• ✅ 仅供开发团队使用
• ✅ 包含技术细节，如配置说明、部署指南等

📋 与网站文档的区别

特征	docs-internal/	/docs/ 和 /en/docs/
目标读者	开发团队	网站用户
内容类型	技术配置、部署指南	软件使用教程、FAQ
是否构建	❌ 不构建	✅ 构建到网站
访问方式	GitHub / 本地查看	网站访问

🤖 AI 助手使用指南

什么时候使用 docs-internal/？

当你需要创建以下类型的文档时，应该放在 docs-internal/：

✅ 应该放在 docs-internal/
- 服务器部署指南
- Nginx/Apache 配置示例
- CI/CD 配置说明
- 数据库设计文档
- API 内部技术文档
- 开发环境设置
- 代码架构说明
- 故障排查手册
- 配置变更记录

什么时候不使用 docs-internal/？

以下类型的文档不应该放在 docs-internal/：

❌ 不应该放在 docs-internal/
- 软件使用教程 → 应放在 /docs/
- 用户FAQ → 应放在 /docs/faq.md
- 功能介绍 → 应放在 /docs/
- 博客文章 → 应放在 /blog/
- 产品说明 → 应放在网站页面

📚 当前文档索引

核心文档

1. README.md - 本文件夹的总说明（必读）
2. 00-文件夹说明.md - 本文档，简要说明

双构建配置相关

3. 配置完成总结.md - 配置总结和验证清单
4. QUICK_START.md - 1分钟快速开始
5. DUAL_BUILD_DEPLOYMENT.md - 完整部署指南

规范文档

6. 文档编写规范.md - 如何编写规范的内部文档

🔍 快速查找

我想...	查看文档
快速开始双构建	QUICK_START.md
了解完整配置	配置完成总结.md
部署到服务器	DUAL_BUILD_DEPLOYMENT.md
编写新的内部文档	文档编写规范.md
了解文件夹用途	README.md

✍️ 创建新文档

# 1. 确定文档类型（参考上方"什么时候使用 docs-internal/"）

# 2. 在 docs-internal/ 中创建 Markdown 文件
touch docs-internal/新功能配置.md

# 3. 参考 文档编写规范.md 编写内容

# 4. 更新 README.md 的文档列表

⚙️ 技术实现

构建排除配置

在两个构建配置中已添加排除规则：

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

// .vitepress/config-en.ts
srcExclude: [
  'docs-internal/**'  // ← 排除内部文档
]

验证方法

构建后检查：

# 构建
npm run build:all

# 验证 docs-internal 不在构建产物中
ls dist-cn/docs-internal   # 应该不存在
ls dist-en/docs-internal    # 应该不存在

📞 需要帮助？

• 📖 阅读 README.md 的详细说明
• 📝 查看 文档编写规范.md
• 💬 联系开发团队

---

文件编号: 00（优先阅读）
创建时间: 2025-01-10
维护者: 开发团队