PROJECT_SKILL.md 8.9 KB

项目级 Skill 最小模板(PROJECT_SKILL.md)

本文件只保留“项目独有且必须描述”的内容。

通用规则(安全、协作、通用编码规范、默认构建流程)统一继承:

  • company_unified_config.md(L1)
  • warehouse_shared_config.md(L2)

建议文件名:PROJECT_SKILL.md
建议位置:项目根目录


一、项目标识(必填)

  • 项目名称:仪陇水务
  • 项目标签:tofly-memory-system 这个skills下面的 language/java/java6这个是我当前项目的框架版本和约束说明
  • 生效范围:<全项目 / backend / frontend>

二、项目独有技术事实(必填)

只写与通用配置不同、且会影响实现结果的事实。

2.1 后端(按需填写)

  • 禁止读取java-crud-common.mdc文件
  • 所有业务表在 建表(CREATE TABLE) 时须含 BaseEntity 公共列(CREATE_USERDELETEDCUR_COMPANY_ID 等),实体统一 extends com.tofly.entity.pojo.BaseEntity;逻辑删除 Java 字段 Boolean deleted 映射列 DELETEDOrganizationEntry/UserNameEntryNUMBER(19)DictEntryVARCHAR2FileEntry*@TableField(exist = false) 无库列。细则见 language/java/java6/java-ylsw-bw.md

2.1 数据库(必填)

  • 使用 oracle11 数据库。
  • 逻辑删除字段使用deleted字段,并使用boolean类型声明。
  • 在生成代码时去除_w等后缀

2.2 前端

  • 界面规范新增如下要求:

1 弹窗界面

  • 窗体边框投影:浅色投影 box-shadow: rgba(0, 0, 0, 0.1) 0px 2px 12px 0px

2 颜色规范

  • 控件颜色:
    • 品牌主图颜色:#2D74E7
    • 成功、完成类:#67C23A
    • 提示类:#E6A23C
    • 报警、禁止类:#F65252
    • 离线、未开始类:#999999
  • 字体颜色:
    • 标题文字:#333333
    • 内容文字(正文颜色):#333333
    • 次要文字(输入控件提示信息):#999999
  • 边框颜色:
    • 一级边框:#999999
    • 二级边框(常用):#DEDEDE
    • 基础白色:#FFFFFF

3 字体规范

  • 备用/扩展色值:#409EFF#F56C6C

4 边框规范

  • 边框线:1px,颜色 #DEDEDE
  • 圆角线:按组件规范统一设置
  • 投影:浅色投影 box-shadow: rgba(0, 0, 0, 0.1) 0px 2px 12px 0px

5 界面规范

  • 文字界面控件:布局按右对齐原则;操作界面控件按左对齐;尽量保持宽度、高度统一,默认 34px
  • 表格:
    • 每页显示条数统一支持:10/20/30/50/100/200/300/500/1000,默认 30 ,数字显示在控件内,条/页位置在控件右侧且不换行。
    • 分页表格配合跳转控件按统一样式展示,放置于表格左下角并与表格左对齐。
    • 分页列表第一列统一显示“序号”,列居中,列值始终从 1 开始。
    • 时间、编号、编码长度固定字段默认居中;字符串长度不固定字段默认左对齐;数字型字段默认右对齐(特殊字段除外)。
    • 表头文案需完整展示,不允许“...”,动态表头按实际场景特殊处理。
    • 表头与列值不允许换行;显示不完整时以“...”展示,鼠标悬停可查看完整内容。
    • 字体与行高规范:表头高度 40px、字号 14px、字体色 #333333、背景 #2D74E7 透明度 20%;表格内容高度 40px、字号 14px、字体色 #505D71、背景交替色(白色与 #000000 透明度 4%);提示类字体颜色 #E6A23C
    • 分页表格统一支持双击事件:优先进入操作界面,其次进入查看界面。
    • 除序号列、操作列外,其他列默认开启排序。
    • 与查询条件组合使用时,查询条件内容必须在表格中可体现。
    • 列表值为空或 null 时统一显示 /
  • 统计表格控件:
    • 必须包含标题、合计。
    • 默认居中显示(特殊情况除外)。
    • 统计列统一单击进入操作或详情页面(可按业务例外)。
    • 标题与列内容需完整显示,不使用省略符号。
    • 字符串列为空或 null 时统一显示 -
  • 按钮控件:
    • 高度尽量统一。
    • 文案要求简洁明了,除字典码表管理外,尽量避免“新增/新建/编辑/添加/删除/修改”等泛化文案,需具体到业务语义。
    • 统一采用无图标样式,按钮样式统一。
  • 输入框控件:
    • 文案长度在 50 个中文以内,统一采用输入框。
    • 文案长度大于 50 个中文,统一采用文本域。
    • 后台字段存储需限定输入长度。
  • 时间控件:
    • 时间区间统一采用两个时间选择控件。
    • 必须控制后一个时间大于等于前一个时间。
    • 时间范围默认“包含边界”,特殊场景可例外。
  • 条件查询:
    • 查询条件统一采用“文案 + 中文冒号(:)+ 控件”的布局方式。
    • 文案与控件不换行显示。
  • 表单:
    • 弹框默认居中,且可拖动。
    • 必填项必须校验,并显示红色 *
    • 填报文案右对齐,操作控件左对齐。
    • 弹框按钮位于右下角,标题位于左上角。
    • 弹框中“确定”在右,“取消”在左。
    • 详情表单无操作按钮。
    • 窗体抬头蓝色背景,高度 54px
    • 窗体关闭按钮尺寸 16x16px,颜色 #FFFFFF
    • 窗体标题字号 16px,颜色 #FFFFFF
    • 内容标题:蓝色分隔条 4x16px,与文字间距 10px,标题字号 16px,颜色 #333333
    • 输入框:边框颜色 #DEDEDE;输入框标题 14px、颜色 #555555;必填星号颜色 #F65252;输入文字字号 14px、正文颜色 #555555、提示文字颜色 #999999
    • 输入控件前间距 12px
    • 窗体左右留白 24px
    • 窗体边框投影:浅色投影 box-shadow: rgba(0, 0, 0, 0.1) 0px 2px 12px 0px
  • 删除操作:
    • 单个删除和批量删除均需先二次确认再执行。
    • 多个删除文案:“确定删除选中的XX条XX信息?”
    • 单条删除文案:“确定删除XX信息?”
  • 无数据页面:统一按规范样式展示。
  • 异步加载过程:
    • 只要存在异步加载,必须显示 Loading 状态。
    • 需处理异步加载成功与失败的异常逻辑。

6 常用控件规范

  • 启用/禁用按钮:
    • 2 字按钮:70x34px,圆角 4px,文字 14px(常规弹框)。
    • 4 字按钮:86x34px,圆角 4px,文字 14px(常规弹框)。
    • 禁用态透明度:60%
  • Radio 单选框:16x16px,选中颜色 #2D74E7,未选中 #999999
  • 多选框:16x16px,选中颜色 #2D74E7,未选中 #999999
  • InputNumber 计数器:180x34px,边框 #DEDEDE,“- / +”背景 #F5F7FA,需定义禁用态。
  • Select 选择器:可清空单选,高度 34px,圆角 4px,宽度最小60px
  • Cascader 级联选择器:高度 34px,圆角 4px
  • Switch 开关:36x18px,开启 #2D74E7,关闭 #999999
  • Slider 滑块:长度按界面自定义,线宽 6px,圆点 14x14px,蓝色 #2D74E7,灰色 #DEDEDE
  • Upload 上传:86x34px,圆角 4px,主题色 #2D74E7
  • Rate 评分:16x15px
  • Result 结果:
    • 圆形图标 18x18px,边框 720x40
    • 绿色 #06B64C(透明度 10%)、灰色 #999999(透明度 10%)、黄色 #E6A23C(透明度 10%)、红色 #F65252(透明度 10%)。

2.3 移动端(UniApp)

  • 技术栈:UniApp(Vue 3)+ Vite@dcloudio/vite-plugin-uni),与 L1「跨平台框架(UniApp)」目录约定一致。
  • 应用根目录:mobile/manage/uniapp/(综合管理端;多 App 时可在 mobile/ 下再建 meter/census/ 等子目录各放一套 uniapp/)。
  • CLI:在 mobile/manage/uniapp/ 执行 npm installnpm run dev:h5(默认 5174)、npm run build:h5;业务源码在 src/pages/static/components/uni_modules/App.vuemain.jsmanifest.jsonpages.jsonuni.scss 等均位于 src/)。
  • 可选仍用 HBuilderX 打开同目录做可视化调试。

三、项目独有路由规则(必填)

  • 目录与多端路径新建与命名须严格遵循 L1 company_unified_config.md §七(与 SKILL.md §1.0、§2.0 一致);存量路径以 §2.0 当轮四列表与根目录 §二 为准。
  • API 与页面路由:待项目落地后在此补充业务级路由约定(如网关前缀、微服务名)。

四、项目独有约束(可选但推荐)

五、项目独有命令覆盖(可选)


六、维护记录


七、执行说明(固定)

  1. 本文件仅补充项目独有信息,不重复通用规则。
  2. 现阶段主要维护「项目标签(路由)」行及 §二 技术事实;「项目标签」对应的 language/ 下约束文件一般在项目初始化创建后较少变更。