본문으로 건너뛰기
cccskills
무료GitHub에 공개

service-claude-md

HTCMC PCHSystem 专用 skill——为各子服务目录生成与更新「分布式 CLAUDE.md」(提炼该服务的雷点、关键要素、文档索引)。当新建子服务、子服务架构发生变更、或需要补齐/更新某个服务的 CLAUDE.md 时使用。

传入服务名(mcdr-plugin / user-service / project-service / scoring-service / title-service / wiki-service / alert-service / frontend),本 skill 自动读取对应架构文档,按统一模板生成或增量更新该服务目录下的 CLAUDE.md。

在 PCHSystem 项目内,只要用户提到「子服务 CLAUDE.md」「为某服务生成/更新 CLAUDE.md」「补齐服务雷点」「服务记忆文件」,或正在新增/改动某个服务目录,就应使用本 skill——禁止手写子服务 CLAUDE.md。

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

설치 방법 보기

포함된 파일(2)

  • SKILL.md7.1 KB
  • templates/service-claude-md.template.md3.0 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

service-claude-md · 子服务 CLAUDE.md 生成 / 维护

1. 这个 skill 做什么

HTCMC PCHSystem 采用分布式 CLAUDE.md(见根 CLAUDE.md §6):

  • 根 CLAUDE.md 只管全项目统一规范(命名、全局红线 R-1~R-12、文档索引)。
  • 每个子服务目录下各有自己的 CLAUDE.md,只描述该服务特有的雷点、关键要素、文档索引。

本 skill 是子服务 CLAUDE.md 的唯一维护入口:读架构文档 → 按模板提炼 → 生成或增量更新。不要手写子服务 CLAUDE.md(根 CLAUDE.md §6 已声明)。


2. 何时用 / 何时不用

用:

  • 新建子服务,需要为其生成 CLAUDE.md
  • 子服务架构变更(接口 / 数据表 / 职责调整),需要更新其 CLAUDE.md
  • 用户说「为 X 服务生成 / 更新 CLAUDE.md」「补齐 X 服务的雷点」

不用:

  • 改根 CLAUDE.md(那是手动维护的统一规范)
  • 生成 API 文档、模块文档等详尽文档(那是 Docs/architecture/ 的职责,本 skill 只做「服务 CLAUDE.md 摘要 + 导航」)

3. 输入:服务名映射表

服务名架构文档(读取源)默认 CLAUDE.md 路径回根相对路径
mcdr-pluginDocs/architecture/services/mcdr-plugin.mdMcdrPlugin/CLAUDE.md..
frontendDocs/architecture/frontend.mdFrontend/CLAUDE.md..
user-serviceDocs/architecture/services/user-service.mdBackend/user_service/CLAUDE.md../..
project-serviceDocs/architecture/services/project-service.mdBackend/project_service/CLAUDE.md../..
scoring-serviceDocs/architecture/services/scoring-service.mdBackend/scoring_service/CLAUDE.md../..
title-serviceDocs/architecture/services/title-service.mdBackend/title_service/CLAUDE.md../..
wiki-serviceDocs/architecture/services/wiki-service.mdBackend/wiki_service/CLAUDE.md../..
alert-serviceDocs/architecture/services/alert-service.mdBackend/alert_service/CLAUDE.md../..

路径为默认值。后端各模块是 Python 包,按 PEP8 用小写(根 CLAUDE.md §1 的命名例外)。生成前先 Glob 确认目标目录是否存在;若不存在(服务尚在规划、代码未建),先与用户确认落点,不要擅自创建一堆空目录。


4. 工作流

  1. 读根规范:读项目根 CLAUDE.md,掌握命名分层、全局红线 R-1~R-12、文档索引——子服务 CLAUDE.md 必须与之一致并引用。
  2. 读服务架构文档:按 §3 表读该服务的 services/{服务名}.md(frontend 读 frontend.md)。
  3. 读相关数据模型:读 Docs/architecture/data-model.md,定位该服务相关的 schema 与表(例如 scoring-service 关心 scoring schema 的 submissions / placement_records / score_ledger)。
  4. 定位目标目录:Glob 确认默认路径的目录是否存在;不存在则与用户确认落点。
  5. 生成或增量更新 CLAUDE.md:
    • 新建:复制 templates/service-claude-md.template.md,逐节填充,把 {ROOT} 占位符替换为 §3 表中的「回根相对路径」。
    • 已存在:只改受影响章节,保留人工补充内容,更新末尾时间戳。
  6. 保障跨工具别名:确认该 CLAUDE.md 同目录存在 AGENTS.md → CLAUDE.md 相对软链(根 CLAUDE.md §6 约定);缺失则 ln -s CLAUDE.md AGENTS.md 创建并 git add。永不单独编辑 AGENTS.md——它只是软链,权威源是 CLAUDE.md。

5. 子服务 CLAUDE.md 必备章节

详见 templates/service-claude-md.template.md。共六节:

  1. 服务定位——一句话 + 指向架构文档的链接
  2. 职责边界——管 / 不管 两栏(从架构文档的「职责边界」表提炼)
  3. 雷点·红线——服务特有的不可违反约束(见 §6 编号规则)
  4. 关键要素——核心实体 / 表、对外接口、依赖的其他服务
  5. 文档索引——该服务相关文档 + 根文档入口
  6. 与根规范的关系——声明遵守根 CLAUDE.md,命名 / 红线以根为准

6. 红线编号规则(重要)

  • 全局红线已在根 CLAUDE.md §3 用 R-1~R-12 编号(如 R-3 清箱时序、R-7 MCDR 是纯客户端、R-2 积分流水 append-only)。
  • 子服务 CLAUDE.md 不重复全局红线,只写服务特有的,用 RS-x 编号(RS-1、RS-2…)。
  • 若是对某条全局红线在该服务的具体化 / 强调,写「遵守 R-x:…」并补该服务特有细节,不必重抄全局定义。
  • 判断标准:该约束写进根 §3 也成立 → 全局红线,子服务只引用;只在该服务语境下才成立 → 它是 RS-x。

7. 增量更新原则

已存在的子服务 CLAUDE.md,遵循最小改动:

  • 只修改受架构变更影响的章节
  • 保留用户 / 人工补充的内容(如特定运维备注)
  • 追加而非重写
  • 每次更新改末尾时间戳
  • 不改章节顺序与标题(保持跨服务模板一致,便于横向对比)

8. 硬约束

  • 命名:服务顶层目录大驼峰(McdrPlugin/、Frontend/),后端 Python 模块包小写(user_service/),遵循根 CLAUDE.md §1。
  • 引用而非复制:架构文档永远权威,子服务 CLAUDE.md 只做摘要 + 链接,不复制 DDL、完整流程图、完整接口表。
  • 中文输出:所有内容简体中文。
  • 不臆造:雷点 / 关键要素必须能在架构文档或数据模型中找到依据;架构文档未覆盖的,标注「待确认」并提示用户,不要编造。

9. 与根 CLAUDE.md 的关系

子服务 CLAUDE.md 是根规范的下游:

  • 命名、全局红线、技术栈以根 CLAUDE.md为准,子服务不覆写。
  • 子服务只补充「该服务特有的」雷点与要素。
  • 任何与根规范冲突的内容,以根为准并修正子服务。

本 skill 由根 CLAUDE.md §6 指定。全局 persistent-context 已在本项目禁用,本 skill 是 PCHSystem 专用的 CLAUDE.md 维护入口,不复用 persistent-context 模板。

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

Redesign GitHub README homepages or create project-native pure SVG, hybrid SVG-composed PNG/WebP, and opt-in animated GIF assets. Use when a user asks to beautify, redesign, rebrand, visually upgrade, simplify, or audit a GitHub README; create only a hero, section headers, diagrams, badges, motion graphics, showcase modules, or other README assets; or turn a repository homepage into a cohesive visual story. If whole-README work versus asset-only work is unclear, ask which scope the user wants. For hero-like assets where pure SVG and generated raster material are both viable, explain the tradeoffs and confirm the implementation before creating the asset.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

YuShenLiu06/PCHSystem92026년 10월 21일 업데이트

HTCMC PCHSystem 专用 skill——指导如何在 git worktree 中正确启动/迁移开发栈 (根 docker-compose 的 postgres+backend、TestServer 的 mc-test、前端 Vite dev)。 PCHSystem 的栈路径锚定主仓(bind mount / external 网络 / MCDR 挂载 / 根 .env 插值), worktree 的目录隔离与之天然冲突,常踩「端口对不上 / token 对不上 / 配置在别的分支」三类坑。 本 skill 给出按「worktree 改了什么」选择的迁移策略 + 端口/token/网络对齐清单 + 红线陷阱。 当用户在 worktree 里要起栈测试、提到「worktree 跑后端/前端/mc-test」「worktree 端口冲突」 「token 对不上 / 401」「主仓有 WIP 没法 checkout 分支」「MCDR reload 看不到 worktree 改动」, 或要在 worktree 改了 Dockerfile / pyproject / 端口 / .env 后验证时,就应使用本 skill。 不用:纯文档或单文件编辑、不涉及运行栈的常规开发、或仅在主仓主线本地开发(不起 worktree)。

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

YuShenLiu06/PCHSystem92026년 10월 21일 업데이트

YuShenLiu06의 스킬 모두 보기

이 스킬의 문제 신고