Files
github-actions[bot] 2fb7602317
CI/CD Pipeline / test-build-boot (push) Failing after 1m37s
CI/CD Pipeline / test-admin (push) Failing after 2m30s
CI/CD Pipeline / test-bigscreen (push) Failing after 56s
CI/CD Pipeline / build-push (ljwx-admin) (push) Has been skipped
CI/CD Pipeline / build-push (ljwx-bigscreen) (push) Has been skipped
CI/CD Pipeline / build-push (ljwx-boot) (push) Has been skipped
CI/CD Pipeline / update-deploy (push) Has been skipped
CI/CD Pipeline / build-pr (ljwx-admin) (push) Has been skipped
CI/CD Pipeline / build-pr (ljwx-bigscreen) (push) Has been skipped
CI/CD Pipeline / build-pr (ljwx-boot) (push) Has been skipped
CI/CD Pipeline / security-scan (push) Successful in 20m44s
docs: auto-update documentation index [skip ci]
2026-02-24 07:51:13 +00:00
..

LJWX Health 项目文档

本目录包含 LJWX Health 项目的所有活跃文档,按功能分类组织

📁 文档分类

01-getting-started - 快速开始

快速开始指南、环境配置、安装说明

02-architecture - 系统架构

系统架构设计、技术选型、模块划分

03-deployment - 部署指南

04-operations - 运维手册

05-features - 功能说明

06-development - 开发指南

  • backend - 后端开发(Spring Boot)
  • frontend - 前端开发(Vue3)
  • api - API 设计与契约

07-compliance - 工程规范

代码规范、审核清单、最佳实践

08-reference - 参考资料

API 参考、配置参考、第三方文档

📋 命名规范

所有文档必须遵循以下命名规范:

  • ✅ 使用小写字母 + 连字符: quick-start-guide.md
  • ❌ 避免大写字母: QuickStartGuide.md
  • ❌ 避免下划线: quick_start_guide.md
  • ❌ 避免日期后缀: guide-20260118.md

🗄️ 历史文档

历史文档和已废弃文档请查看 ../archive/ 目录

🛠️ 文档管理工具

# 验证文档命名规范
./scripts/validate-doc-naming.sh

# 整理文档结构
./scripts/organize-docs.sh

# 生成文档索引
./scripts/generate-doc-index.sh

📝 创建新文档

决策树:

  1. 是否是项目核心文档?

    • 是 → 根目录(需审批)
    • 否 → 继续
  2. 是否是活跃的、需要维护的文档?

    • 是 → docs/{category}/
    • 否 → 继续
  3. 是否是历史实施报告、修复记录?

    • 是 → archive/{year}/
    • 否 → archive/deprecated/

最后更新: 2026-02-24 07:51:07