一刻工坊命名规范文档

统一命名体系 - 让架构清晰易懂，便于记忆和维护

📋 概览

KKmusic 一刻工坊采用 版本号 + 端 的命名方式，将不同时期、不同端的功能模块清晰划分。

🏗️ 三大体系

┌─────────────────────────────────────────────────────────┐
│  KKmusic 一刻工坊 - 三端架构                              │
├─────────────────────────────────────────────────────────┤
│                                                           │
│  🎬 V1 Desktop - 桌面工作台（旧版）                       │
│     技术栈: Vue2 + Element UI                            │
│     访问地址: /v1/                                        │
│     用途: 完整的桌面端创作系统                             │
│     功能: 一刻成歌、画坊、影坊、成片                       │
│                                                           │
│  📱 V2 Mobile - 移动拍摄端（新版核心）                    │
│     技术栈: Vue3 + Vite + Element Plus                   │
│     访问地址: /mobile/                                    │
│     用途: 手机端任务拍摄、素材管理、增长数据                │
│     功能: 拍摄任务、素材相册、模板工作室、增长仪表盘         │
│                                                           │
│  🖥️ V2 Studio - 桌面工作室（新版）                       │
│     技术栈: Vue3 + Vite + Pinia                          │
│     访问地址: /studio/                                    │
│     用途: 项目管理、工作流、团队协作                       │
│     功能: 项目中心、工作流、素材库、语料库、AI起号问诊      │
│                                                           │
└─────────────────────────────────────────────────────────┘

🎯 路由命名规范

V2 Mobile - 移动拍摄端

路由路径	功能	页面标题
`/mobile`	首页（拍摄任务）	V2 Mobile - 拍摄任务
`/mobile/assets`	素材相册	V2 Mobile - 素材相册
`/mobile/templates`	模板工作室	V2 Mobile - 模板工作室
`/mobile/growth`	增长仪表盘	V2 Mobile - 增长仪表盘

V2 Studio - 桌面工作室

路由路径	功能	页面标题
`/studio`	首页（重定向到 /studio/today）	-
`/studio/today`	今天要干嘛	V2 Studio - 今天要干嘛
`/studio/projects`	项目中心	V2 Studio - 项目中心
`/studio/projects/:id`	项目控制台	V2 Studio - 项目控制台
`/studio/projects/:id/create`	创建内容	V2 Studio - 创建内容
`/studio/projects/:id/path/:pathType`	创作路径	V2 Studio - 创作路径
`/studio/materials`	素材库	V2 Studio - 素材库
`/studio/corpus`	语料库	V2 Studio - 语料库
`/studio/workflows`	工作流模版库	V2 Studio - 工作流模版库
`/studio/templates`	行业模板库	V2 Studio - 行业模板库
`/studio/strategy`	AI 起号问诊	V2 Studio - AI 起号问诊
`/studio/subscription`	订阅管理	V2 Studio - 订阅管理
`/studio/publish`	发布中心	V2 Studio - 发布中心

V1 Desktop - 桌面工作台（旧版）

路由路径	功能	页面标题
`/v1`	首页（重定向到 /v1/song）	-
`/v1/song`	一刻成歌	V1 Desktop - 一刻成歌
`/v1/image`	一刻画坊	V1 Desktop - 一刻画坊
`/v1/mv`	一刻影坊	V1 Desktop - 一刻影坊
`/v1/final`	一刻成片	V1 Desktop - 一刻成片

注意: 旧版静态 HTML 仍然保留在 /public/v11/ 目录下，通过后端静态文件服务访问。

🔄 兼容性重定向

为了保证旧链接正常工作，系统提供了大量的兼容性重定向：

javascript

// 移动端旧路径重定向
{ path: '/mobile-demo', redirect: '/mobile' }
{ path: '/asset-gallery', redirect: '/mobile/assets' }
{ path: '/template-studio', redirect: '/mobile/templates' }
{ path: '/growth-dashboard', redirect: '/mobile/growth' }

// 桌面端旧路径重定向
{ path: '/today', redirect: '/studio/today' }
{ path: '/projects', redirect: '/studio/projects' }
{ path: '/materials', redirect: '/studio/materials' }
{ path: '/corpus', redirect: '/studio/corpus' }
// ... 更多重定向

// V1 旧工具路径重定向
{ path: '/tools/music', redirect: '/v1/song' }
{ path: '/tools/song', redirect: '/v1/song' }
{ path: '/tools/image', redirect: '/v1/image' }
{ path: '/tools/mv', redirect: '/v1/mv' }
{ path: '/tools/final', redirect: '/v1/final' }

📂 文件夹结构

KKmusic/
├── frontend/
│   ├── public/
│   │   └── v11/              # V1 Desktop 静态文件（旧版）
│   └── src/
│       ├── views/
│       │   ├── mobile/       # V2 Mobile 页面
│       │   │   ├── MobileCaptureDemo.vue
│       │   │   ├── AssetGallery.vue
│       │   │   ├── TemplateStudio.vue
│       │   │   └── GrowthDashboard.vue
│       │   ├── tools/        # V1 Desktop 工具页面
│       │   │   ├── SongStudio.vue
│       │   │   ├── ImageStudio.vue
│       │   │   ├── MvStudio.vue
│       │   │   └── FinalStudio.vue
│       │   └── ...           # V2 Studio 其他页面
│       └── router/
│           └── index.js      # 统一路由配置
└── backend/
    └── ...

🎨 UI 标识

侧边栏版本标识

V2 Studio 侧边栏显示: V2 Studio
V1 Desktop 无侧边栏（独立页面）
V2 Mobile 无侧边栏（全屏模式）

浏览器标题格式

{页面功能} - 一刻工坊

示例:
- V2 Mobile - 拍摄任务 - 一刻工坊
- V2 Studio - 项目中心 - 一刻工坊
- V1 Desktop - 一刻成歌 - 一刻工坊

💡 记忆口诀

V1 是工作台 - 老版桌面全功能
V2 分两端   - 手机拍、桌面管
Mobile 拍   - 移动拍摄任务端
Studio 管   - 桌面工作室管理端

🚀 快速访问

开发环境

版本	URL	说明
V2 Mobile	http://localhost:3000/mobile	移动端首页（默认）
V2 Studio	http://localhost:3000/studio	桌面工作室首页
V1 Desktop	http://localhost:3001/v11/	旧版桌面工作台

生产环境

版本	URL	说明
V2 Mobile	https://yourdomain.com/mobile	移动端首页（默认）
V2 Studio	https://yourdomain.com/studio	桌面工作室首页
V1 Desktop	https://yourdomain.com/v11/	旧版桌面工作台

📝 代码规范

1. 路由配置

javascript

// ✅ 推荐：使用新路径
const routes = [
  {
    path: '/mobile',
    name: 'V2MobileHome',
    component: MobileCaptureDemo,
    meta: { requiresAuth: false, fullscreen: true, title: 'V2 Mobile - 拍摄任务' }
  },
  {
    path: '/studio/projects',
    name: 'V2StudioProjects',
    component: ProjectCenter,
    meta: { requiresAuth: true, title: 'V2 Studio - 项目中心' }
  },
  {
    path: '/v1/song',
    name: 'V1DesktopSong',
    component: SongStudio,
    meta: { requiresAuth: true, title: 'V1 Desktop - 一刻成歌' }
  }
]

2. 组件导航

vue

<!-- ✅ 推荐：使用新路径 -->
<router-link to="/mobile/assets">素材库</router-link>
<router-link to="/studio/projects">项目中心</router-link>

<!-- ❌ 避免：使用旧路径 -->
<router-link to="/asset-gallery">素材库</router-link>
<router-link to="/projects">项目中心</router-link>

3. 编程式导航

javascript

// ✅ 推荐：使用新路径
router.push('/studio/projects')
router.push(`/studio/projects/${projectId}/create`)

// ❌ 避免：使用旧路径
router.push('/projects')
router.push(`/projects/${projectId}/create`)

🔍 常见问题

Q1: 为什么根路径 `/` 默认跳转到 `/mobile`？

A: 因为 V2 Mobile 是当前核心功能，面向本地商家的移动端拍摄和内容生成。这是项目的主要价值点。

Q2: V1 Desktop 还会继续维护吗？

A: V1 Desktop 作为旧版功能保留，供需要使用"一刻成歌"、"一刻画坊"等经典工具的用户使用。新功能将主要在 V2 体系中开发。

Q3: 如何在移动端和桌面端之间切换？

移动端访问: /mobile
桌面端访问: /studio 或 /v1
可通过浏览器地址栏直接输入路径切换

Q4: 页面标题中的 V1/V2 前缀会显示给用户吗？

A: 会的，这有助于用户明确当前所在的功能模块。未来可通过配置决定是否显示。

📅 更新日志

2024-12-05: 完成全系统命名统一，采用"版本号 + 端"命名方案
2024-12-05: 添加兼容性重定向，确保旧链接正常工作
2024-12-05: 更新所有组件和路由配置，统一导航路径

🤝 贡献指南

在添加新功能或页面时，请遵循以下命名规范：

确定所属体系: V1 Desktop / V2 Mobile / V2 Studio
使用正确前缀: /v1/ /mobile/ /studio/
命名路由名称: V1Desktop* V2Mobile* V2Studio*
设置页面标题: V1 Desktop - * V2 Mobile - * V2 Studio - *
添加兼容重定向: 如果替换旧功能，添加重定向规则

一刻工坊团队 | 让内容创作更简单 🚀

一刻工坊 命名规范文档 ​

📋 概览 ​

🏗️ 三大体系 ​

🎯 路由命名规范 ​

V2 Mobile - 移动拍摄端 ​

V2 Studio - 桌面工作室 ​

V1 Desktop - 桌面工作台（旧版） ​

🔄 兼容性重定向 ​

📂 文件夹结构 ​

🎨 UI 标识 ​

侧边栏版本标识 ​

浏览器标题格式 ​

💡 记忆口诀 ​

🚀 快速访问 ​

开发环境 ​

生产环境 ​

📝 代码规范 ​

1. 路由配置 ​

2. 组件导航 ​

3. 编程式导航 ​

🔍 常见问题 ​

Q1: 为什么根路径 / 默认跳转到 /mobile？ ​

Q2: V1 Desktop 还会继续维护吗？ ​

Q3: 如何在移动端和桌面端之间切换？ ​

Q4: 页面标题中的 V1/V2 前缀会显示给用户吗？ ​

📅 更新日志 ​

🤝 贡献指南 ​

一刻工坊命名规范文档

📋 概览

🏗️ 三大体系

🎯 路由命名规范

V2 Mobile - 移动拍摄端

V2 Studio - 桌面工作室

V1 Desktop - 桌面工作台（旧版）

🔄 兼容性重定向

📂 文件夹结构

🎨 UI 标识

侧边栏版本标识

浏览器标题格式

💡 记忆口诀

🚀 快速访问

开发环境

生产环境

📝 代码规范

1. 路由配置

2. 组件导航

3. 编程式导航

🔍 常见问题

Q1: 为什么根路径 `/` 默认跳转到 `/mobile`？

Q2: V1 Desktop 还会继续维护吗？

Q3: 如何在移动端和桌面端之间切换？

Q4: 页面标题中的 V1/V2 前缀会显示给用户吗？

📅 更新日志

🤝 贡献指南