CLAUDE.md 4.6 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

语言约束

本项目默认使用简体中文,新增/更新的 skill、规则、记忆等文件应该使用简体中文(可允许部分必须要英文字母的表述,如 API、URL、ID 等)。

项目概述

这是一个通用的企业级员工 AI 工作台,包括但不限于:

  • 需求分析(requirements-analysis)

  • 撰写 PRD / FSD(prd-writer)

  • 撰写测试用例

  • 构建 PC 端后台 Demo(pc-demo)

  • 构建 H5 移动端 Demo

工作流程:需求分析 → PRD 撰写 → PC/H5 Demo 开发 → 测试用例编写

目录结构

rongshu/
├── CLAUDE.md                          # 本文件
├── .claude/skills/                    # Claude Code 技能目录
│   ├── prd-writer/                    # PRD 撰写技能
│   ├── requirements-analysis/         # 需求分析技能
│   ├── pc-demo/                       # PC 端 Demo 构建技能
│   └── lark-*/                        # 飞书集成技能(文档、表格、日历等)
├── .resources/                        # 截图、图片等资源文件
├── 工作空间/                           # 产研工作目录
│   └── 产研/
│       └── <业务线>/                   # 如:权益
│           └── <项目名称>/             # 如:汇丰全行
│               ├── 需求文档/           # PRD、FSD 等需求文档
│               │   └── screenshots/   # 需求文档配图
│               ├── 测试用例/           # 测试用例文档
│               └── 产品原型/           # Demo 项目
│                   ├── pc-demo/       # PC 端后台 Demo(Vue 3)
│                   └── h5-demo/       # H5 移动端 Demo
└── 企业知识和技能库/                    # 企业知识沉淀(待建设)

架构要点(PC Demo)

  • 技术栈:Vue 3.5 + Vue Router 4 + Element Plus 2.10 + Vite 5

  • 无真实后端:Mock.js 在浏览器内拦截 /api/* 请求,生成假数据

  • 认证机制localStorage.token 存储登录态,路由守卫 beforeEach 检查 token

  • 新增页面两步:① src/router/index.js 加路由(含 meta.title) → ② Layout.vue<el-menu> 加菜单项

  • Mock 接口格式:所有返回必须遵循 { code: 200, data, msg } 结构

  • 定制化路径:客户定制页面遵循 customization/<客户>/<模块> 路径前缀

常用命令(PC Demo)

cd 工作空间/产研/权益/汇丰全行/产品原型/pc-demo
npm install        # 安装依赖
npm run dev        # 启动 Vite 开发服务器(端口 8080,热更新)
npm run build      # 生产构建
npm run lint       # ESLint 校验并自动修复

无测试框架,无单测命令。

技能说明

requirements-analysis(需求分析)

当用户提到"需求分析"、"分析需求"、"撰写需求分析"、"需求调研"时使用。在 PRD 撰写前进行需求调研、分析和确认。输出到 工作空间/产研/<业务线>/<项目名称>/需求文档/ 目录。

prd-writer(PRD 撰写)

当用户提到"写PRD"、"撰写需求"、"产品需求"、"需求背景"、"功能设计"、"撰写产品需求文档"时使用。按五段式模板输出(需求背景→需求目标→流程图→功能清单→系统改造),包含 Mermaid 流程图。输出到 工作空间/产研/<业务线>/<项目名称>/需求文档/ 目录。

pc-demo(PC 端 Demo)

当用户提到"PC后台"、"后台页面"、"新增页面"、"添加菜单"、"PC端开发"、"后台列表"、"后台详情"、"管理后台"、"新建页面"、"开发页面"、"页面模板"等关键词时使用。即使用户只是简单提到要做一个后台页面或管理界面,也应该触发此 skill。

注意:pc-demo skill 模板文档描述的是 React + Ant Design + Vite,但实际项目使用 Vue 3.5 + Element Plus 2.10 + Vite 5。开发时以对应项目的 CLAUDE.md 和实际代码为准。

文档约定

  • 需求文档存放在 工作空间/产研/<业务线>/<项目名称>/需求文档/ 目录

  • 测试用例存放在 工作空间/产研/<业务线>/<项目名称>/测试用例/ 目录

  • 产品原型存放在 工作空间/产研/<业务线>/<项目名称>/产品原型/ 目录

  • 文件命名格式:<简述>-<类型>-<日期>.md(如 销售数据导出-需求沟通记录-20260410.md

  • 流程图使用 Mermaid 语法