ignission / ignission/claude-code-ark

図解 authoring 規約: doc ノードの label 長が sample と一致していない

Open
#307 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2
Forks
0
Avg merge
1h 31m
Merged PRs (30d)
77

Description

問題

.claude/skills/diagram-authoring/SKILL.md は文書型(type: "doc")ノードの label について「60〜80文字の抜粋だけを置く」と規定している。

一方、同梱の sample .claude/diagrams/_examples/order-flow-design.diagram.html の label は実測で 36〜41 文字であり、規定を満たしていない。diagram-authoring-contract.test.ts も label 長を検証していないため、この不整合は CI で検出されない。

どちらを正とするか

規約側の数字が過剰だと考えている。

  • label の役割は「モデル上でそのブロックを識別するための抜粋」であり、要約でも本文の複製でもない
  • doc 型は HTML を正本とし、本文を意味モデルへ二重化しない設計(PR #305)。label が長いほどこの原則から離れる
  • 日本語で 60〜80 文字は 2 行相当で、識別用の抜粋としては明らかに長い

したがって sample を規約に合わせるのではなく、SKILL.md の数字を見直す方向が妥当と考える。

対応案

  • SKILL.md の「60〜80文字」を、識別用の抜粋として現実的な範囲へ改める(sample の実測 36〜41 文字が収まる形)
  • 数字を決めたら diagram-authoring-contract.test.ts に label 長の検証を追加し、sample と規約が二度とずれないようにする

補足

PR #305 の CodeRabbit レビュー(comment id 3747360512, Minor)由来。PR #305 では sample・規約とも変更していない。

Refs #300, #305

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read .claude/skills/diagram-authoring/SKILL.md, .claude/diagrams/_examples/order-flow-design.diagram.html, and diagram-authoring-contract.test.ts, using PR #305 for context. Choose a realistic label range that includes the sample's 36–41 characters, update the convention, and add the missing length assertion. Run the contract test to confirm the sample and rule remain aligned.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, testing-qa
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.