@su-record/vibe 2.8.52 โ 2.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.example +37 -37
- package/CLAUDE.md +169 -169
- package/LICENSE +21 -21
- package/README.ko.md +43 -128
- package/README.md +43 -128
- package/agents/architect-low.md +41 -41
- package/agents/architect-medium.md +59 -59
- package/agents/architect.md +80 -80
- package/agents/build-error-resolver.md +115 -115
- package/agents/compounder.md +261 -261
- package/agents/diagrammer.md +178 -178
- package/agents/docs/api-documenter.md +99 -99
- package/agents/docs/changelog-writer.md +93 -93
- package/agents/e2e-tester.md +294 -294
- package/agents/event/event-comms.md +78 -78
- package/agents/event/event-content.md +68 -68
- package/agents/event/event-image.md +95 -95
- package/agents/event/event-ops.md +84 -84
- package/agents/event/event-scheduler.md +69 -69
- package/agents/event/event-speaker.md +86 -86
- package/agents/explorer-low.md +42 -42
- package/agents/explorer-medium.md +59 -59
- package/agents/explorer.md +48 -48
- package/agents/implementer-low.md +43 -43
- package/agents/implementer-medium.md +52 -52
- package/agents/implementer.md +54 -54
- package/agents/junior-mentor.md +141 -141
- package/agents/planning/requirements-analyst.md +84 -84
- package/agents/planning/ux-advisor.md +83 -83
- package/agents/qa/acceptance-tester.md +86 -86
- package/agents/qa/edge-case-finder.md +93 -93
- package/agents/qa/qa-coordinator.md +131 -131
- package/agents/refactor-cleaner.md +143 -143
- package/agents/research/best-practices-agent.md +199 -199
- package/agents/research/codebase-patterns-agent.md +157 -157
- package/agents/research/framework-docs-agent.md +188 -188
- package/agents/research/security-advisory-agent.md +213 -213
- package/agents/review/architecture-reviewer.md +107 -107
- package/agents/review/complexity-reviewer.md +116 -116
- package/agents/review/data-integrity-reviewer.md +88 -88
- package/agents/review/git-history-reviewer.md +103 -103
- package/agents/review/performance-reviewer.md +86 -86
- package/agents/review/python-reviewer.md +150 -150
- package/agents/review/rails-reviewer.md +139 -139
- package/agents/review/react-reviewer.md +144 -144
- package/agents/review/security-reviewer.md +80 -80
- package/agents/review/simplicity-reviewer.md +140 -140
- package/agents/review/test-coverage-reviewer.md +116 -116
- package/agents/review/typescript-reviewer.md +127 -127
- package/agents/searcher.md +54 -54
- package/agents/simplifier.md +120 -120
- package/agents/tester.md +49 -49
- package/agents/ui/ui-a11y-auditor.md +93 -93
- package/agents/ui/ui-antipattern-detector.md +102 -102
- package/agents/ui/ui-dataviz-advisor.md +69 -69
- package/agents/ui/ui-design-system-gen.md +57 -57
- package/agents/ui/ui-industry-analyzer.md +49 -49
- package/agents/ui/ui-layout-architect.md +65 -65
- package/agents/ui/ui-stack-implementer.md +68 -68
- package/agents/ui/ux-compliance-reviewer.md +81 -81
- package/agents/ui-previewer.md +258 -258
- package/commands/vibe.analyze.md +379 -379
- package/commands/vibe.docs.md +32 -32
- package/commands/vibe.event.md +163 -163
- package/commands/vibe.figma.md +69 -69
- package/commands/vibe.review.md +686 -686
- package/commands/vibe.run.md +2276 -2276
- package/commands/vibe.spec.md +1195 -1195
- package/commands/vibe.spec.review.md +609 -609
- package/commands/vibe.trace.md +259 -259
- package/commands/vibe.utils.md +413 -413
- package/commands/vibe.verify.md +510 -510
- package/dist/cli/collaborator.js +52 -52
- package/dist/cli/commands/config.js +9 -9
- package/dist/cli/commands/evolution.js +12 -12
- package/dist/cli/commands/figma.js +20 -20
- package/dist/cli/commands/info.js +53 -53
- package/dist/cli/commands/init.js +5 -5
- package/dist/cli/commands/remove.js +14 -14
- package/dist/cli/commands/sentinel.js +27 -27
- package/dist/cli/commands/skills.js +5 -5
- package/dist/cli/commands/slack.js +10 -10
- package/dist/cli/commands/stats.js +6 -6
- package/dist/cli/commands/telegram.js +12 -12
- package/dist/cli/detect.js +32 -32
- package/dist/cli/index.js +51 -51
- package/dist/cli/llm/claude-commands.js +16 -16
- package/dist/cli/llm/config.js +18 -18
- package/dist/cli/llm/gemini-commands.js +16 -16
- package/dist/cli/llm/gpt-commands.js +19 -19
- package/dist/cli/llm/help.js +21 -21
- package/dist/cli/postinstall/cursor-agents.js +32 -32
- package/dist/cli/postinstall/cursor-rules.js +83 -83
- package/dist/cli/postinstall/cursor-skills.js +743 -743
- package/dist/cli/postinstall/main.d.ts.map +1 -1
- package/dist/cli/postinstall/main.js +40 -66
- package/dist/cli/postinstall/main.js.map +1 -1
- package/dist/cli/setup/Provisioner.js +42 -42
- package/dist/infra/lib/CostAccumulator.d.ts +58 -0
- package/dist/infra/lib/CostAccumulator.d.ts.map +1 -0
- package/dist/infra/lib/CostAccumulator.js +131 -0
- package/dist/infra/lib/CostAccumulator.js.map +1 -0
- package/dist/infra/lib/DeepInit.js +24 -24
- package/dist/infra/lib/IterationTracker.js +11 -11
- package/dist/infra/lib/PythonParser.js +108 -108
- package/dist/infra/lib/ReviewRace.js +96 -96
- package/dist/infra/lib/SkillFrontmatter.js +28 -28
- package/dist/infra/lib/SkillQualityGate.js +9 -9
- package/dist/infra/lib/SkillRepository.js +159 -159
- package/dist/infra/lib/TokenBudgetTracker.d.ts +13 -0
- package/dist/infra/lib/TokenBudgetTracker.d.ts.map +1 -1
- package/dist/infra/lib/TokenBudgetTracker.js +44 -3
- package/dist/infra/lib/TokenBudgetTracker.js.map +1 -1
- package/dist/infra/lib/UltraQA.js +99 -99
- package/dist/infra/lib/autonomy/AuditStore.js +41 -41
- package/dist/infra/lib/autonomy/ConfirmationStore.js +30 -30
- package/dist/infra/lib/autonomy/EventOutbox.js +38 -38
- package/dist/infra/lib/autonomy/PolicyEngine.d.ts +3 -3
- package/dist/infra/lib/autonomy/PolicyEngine.js +18 -18
- package/dist/infra/lib/autonomy/SecuritySentinel.js +1 -1
- package/dist/infra/lib/autonomy/SuggestionStore.js +33 -33
- package/dist/infra/lib/embedding/VectorStore.js +22 -22
- package/dist/infra/lib/evolution/AgentAnalyzer.js +10 -10
- package/dist/infra/lib/evolution/DescriptionOptimizer.js +21 -21
- package/dist/infra/lib/evolution/GenerationRegistry.js +36 -36
- package/dist/infra/lib/evolution/InsightStore.js +90 -90
- package/dist/infra/lib/evolution/ParityTester.js +57 -57
- package/dist/infra/lib/evolution/RollbackManager.js +5 -5
- package/dist/infra/lib/evolution/SkillBenchmark.js +23 -23
- package/dist/infra/lib/evolution/SkillEvalRunner.js +50 -50
- package/dist/infra/lib/evolution/SkillGapDetector.js +10 -10
- package/dist/infra/lib/evolution/UsageTracker.js +28 -28
- package/dist/infra/lib/gemini/orchestration.js +5 -5
- package/dist/infra/lib/gpt/orchestration.js +4 -4
- package/dist/infra/lib/memory/KnowledgeGraph.js +4 -4
- package/dist/infra/lib/memory/MemorySearch.js +57 -57
- package/dist/infra/lib/memory/MemoryStorage.js +181 -181
- package/dist/infra/lib/memory/ObservationStore.js +28 -28
- package/dist/infra/lib/memory/ReflectionStore.js +30 -30
- package/dist/infra/lib/memory/SessionRAGRetriever.js +7 -7
- package/dist/infra/lib/memory/SessionRAGStore.js +225 -225
- package/dist/infra/lib/memory/SessionSummarizer.js +9 -9
- package/dist/infra/orchestrator/AgentManager.js +12 -12
- package/dist/infra/orchestrator/AgentRegistry.js +65 -65
- package/dist/infra/orchestrator/MultiLlmResearch.js +8 -8
- package/dist/infra/orchestrator/SwarmOrchestrator.test.js +16 -16
- package/dist/infra/orchestrator/parallelResearch.js +24 -24
- package/dist/tools/convention/analyzeComplexity.test.js +115 -115
- package/dist/tools/convention/validateCodeQuality.test.js +104 -104
- package/dist/tools/memory/createMemoryTimeline.js +10 -10
- package/dist/tools/memory/getMemoryGraph.js +12 -12
- package/dist/tools/memory/getSessionContext.js +9 -9
- package/dist/tools/memory/linkMemories.js +14 -14
- package/dist/tools/memory/listMemories.js +4 -4
- package/dist/tools/memory/recallMemory.js +4 -4
- package/dist/tools/memory/saveMemory.js +4 -4
- package/dist/tools/memory/searchMemoriesAdvanced.js +23 -23
- package/dist/tools/semantic/analyzeDependencyGraph.js +12 -12
- package/dist/tools/semantic/astGrep.test.js +6 -6
- package/dist/tools/spec/prdParser.test.js +171 -171
- package/dist/tools/spec/specGenerator.js +169 -169
- package/dist/tools/spec/traceabilityMatrix.js +64 -64
- package/dist/tools/spec/traceabilityMatrix.test.js +28 -28
- package/hooks/gemini-hooks.json +73 -73
- package/hooks/hooks.json +174 -174
- package/hooks/scripts/__tests__/keyword-detector.test.js +199 -199
- package/hooks/scripts/__tests__/pre-tool-guard.test.js +286 -286
- package/hooks/scripts/__tests__/sentinel-guard.test.js +210 -210
- package/hooks/scripts/auto-commit.js +97 -97
- package/hooks/scripts/auto-format.js +64 -64
- package/hooks/scripts/auto-test.js +81 -81
- package/hooks/scripts/code-check.js +268 -268
- package/hooks/scripts/codex-detect.js +46 -46
- package/hooks/scripts/codex-review-gate.js +80 -80
- package/hooks/scripts/command-log.js +32 -32
- package/hooks/scripts/context-save.js +353 -353
- package/hooks/scripts/evolution-engine.js +91 -91
- package/hooks/scripts/figma-extract.js +635 -477
- package/hooks/scripts/hud-status.js +321 -321
- package/hooks/scripts/keyword-detector.js +214 -214
- package/hooks/scripts/llm-orchestrate.js +572 -572
- package/hooks/scripts/post-edit.js +32 -32
- package/hooks/scripts/pr-test-gate.js +52 -52
- package/hooks/scripts/pre-tool-guard.js +214 -159
- package/hooks/scripts/prompt-dispatcher.js +185 -185
- package/hooks/scripts/sentinel-guard.js +131 -131
- package/hooks/scripts/session-start.js +177 -177
- package/hooks/scripts/skill-injector.js +83 -83
- package/hooks/scripts/stop-notify.js +209 -209
- package/hooks/scripts/utils.js +243 -243
- package/languages/csharp-unity.md +515 -515
- package/languages/gdscript-godot.md +470 -470
- package/languages/ruby-rails.md +489 -489
- package/languages/typescript-angular.md +433 -433
- package/languages/typescript-astro.md +416 -416
- package/languages/typescript-electron.md +406 -406
- package/languages/typescript-nestjs.md +524 -524
- package/languages/typescript-svelte.md +407 -407
- package/languages/typescript-tauri.md +365 -365
- package/package.json +101 -101
- package/skills/agents-md/SKILL.md +121 -121
- package/skills/agents-md/rubrics/what-to-keep.md +49 -49
- package/skills/agents-md/templates/agents-md.md +36 -36
- package/skills/arch-guard/SKILL.md +181 -181
- package/skills/arch-guard/agents/detector.md +48 -48
- package/skills/arch-guard/agents/reporter.md +48 -48
- package/skills/arch-guard/agents/rule-generator.md +49 -49
- package/skills/arch-guard/agents/violation-checker.md +51 -51
- package/skills/arch-guard/frameworks/clean-architecture.md +108 -108
- package/skills/arch-guard/frameworks/solid.md +102 -102
- package/skills/arch-guard/scripts/check-boundaries.js +90 -90
- package/skills/arch-guard/templates/arch-rules.json +47 -47
- package/skills/arch-guard/templates/violation-report.md +53 -53
- package/skills/brand-assets/SKILL.md +147 -147
- package/skills/brand-assets/rubrics/asset-checklist.md +98 -98
- package/skills/brand-assets/templates/brand-guide.md +161 -161
- package/skills/capability-loop/SKILL.md +168 -168
- package/skills/capability-loop/agents/capability-designer.md +61 -61
- package/skills/capability-loop/agents/failure-analyst.md +55 -55
- package/skills/capability-loop/agents/implementer.md +50 -50
- package/skills/capability-loop/agents/tester.md +53 -53
- package/skills/capability-loop/templates/capability-spec.md +118 -118
- package/skills/capability-loop/templates/failure-analysis.md +118 -118
- package/skills/characterization-test/SKILL.md +207 -207
- package/skills/characterization-test/agents/behavior-capturer.md +50 -50
- package/skills/characterization-test/agents/coverage-checker.md +54 -54
- package/skills/characterization-test/agents/reporter.md +50 -50
- package/skills/characterization-test/agents/test-writer.md +49 -49
- package/skills/characterization-test/rubrics/coverage-criteria.md +53 -53
- package/skills/characterization-test/templates/test-template.ts +101 -101
- package/skills/chub-usage/SKILL.md +139 -139
- package/skills/claude-md-guide/SKILL.md +351 -351
- package/skills/claude-md-guide/rubrics/anti-patterns.md +88 -88
- package/skills/claude-md-guide/templates/claude-md.md +54 -54
- package/skills/commerce-patterns/SKILL.md +64 -64
- package/skills/commerce-patterns/rubrics/checkout-flow.md +48 -48
- package/skills/commerce-patterns/templates/product-schema.md +85 -85
- package/skills/commit-push-pr/SKILL.md +77 -77
- package/skills/commit-push-pr/agents/change-analyzer.md +55 -55
- package/skills/commit-push-pr/agents/message-writer.md +50 -50
- package/skills/commit-push-pr/agents/pr-writer.md +58 -58
- package/skills/commit-push-pr/agents/reviewer.md +52 -52
- package/skills/commit-push-pr/rubrics/commit-message.md +73 -73
- package/skills/commit-push-pr/templates/pr-body.md +63 -63
- package/skills/context7-usage/SKILL.md +106 -106
- package/skills/context7-usage/rubrics/when-to-use.md +50 -50
- package/skills/create-prd/SKILL.md +90 -90
- package/skills/create-prd/agents/edge-case-finder.md +48 -48
- package/skills/create-prd/agents/prioritizer.md +60 -60
- package/skills/create-prd/agents/requirements-writer.md +48 -48
- package/skills/create-prd/agents/researcher.md +55 -55
- package/skills/create-prd/agents/reviewer.md +54 -54
- package/skills/create-prd/frameworks/jobs-to-be-done.md +96 -96
- package/skills/create-prd/frameworks/rice-scoring.md +97 -97
- package/skills/create-prd/orchestrator.md +70 -70
- package/skills/create-prd/rubrics/completeness.md +58 -58
- package/skills/create-prd/templates/prd.md +139 -139
- package/skills/design-audit/SKILL.md +152 -152
- package/skills/design-audit/agents/a11y-auditor.md +43 -43
- package/skills/design-audit/agents/performance-auditor.md +46 -46
- package/skills/design-audit/agents/responsive-auditor.md +46 -46
- package/skills/design-audit/agents/scorer.md +47 -47
- package/skills/design-audit/agents/slop-detector.md +47 -47
- package/skills/design-audit/frameworks/core-web-vitals.md +107 -107
- package/skills/design-audit/frameworks/wcag-checklist.md +64 -64
- package/skills/design-audit/orchestrator.md +64 -64
- package/skills/design-audit/rubrics/ai-slop-patterns.md +83 -83
- package/skills/design-audit/rubrics/scoring.md +63 -63
- package/skills/design-audit/templates/report.md +88 -88
- package/skills/design-critique/SKILL.md +139 -139
- package/skills/design-critique/rubrics/ux-heuristics.md +143 -143
- package/skills/design-critique/templates/critique-report.md +86 -86
- package/skills/design-distill/SKILL.md +130 -130
- package/skills/design-distill/templates/design-system.md +132 -132
- package/skills/design-normalize/SKILL.md +133 -133
- package/skills/design-normalize/rubrics/token-naming.md +117 -117
- package/skills/design-normalize/templates/token-audit.md +89 -89
- package/skills/design-polish/SKILL.md +131 -131
- package/skills/design-polish/rubrics/polish-checklist.md +68 -68
- package/skills/design-polish/templates/polish-report.md +64 -64
- package/skills/design-teach/SKILL.md +182 -182
- package/skills/design-teach/rubrics/brand-personality.md +73 -73
- package/skills/design-teach/templates/design-context.json +36 -36
- package/skills/e2e-commerce/SKILL.md +62 -62
- package/skills/e2e-commerce/templates/test-scenarios.md +170 -170
- package/skills/event-comms/SKILL.md +162 -162
- package/skills/event-comms/templates/email-invite.md +99 -99
- package/skills/event-comms/templates/sns-post.md +133 -133
- package/skills/event-ops/SKILL.md +198 -198
- package/skills/event-ops/rubrics/contingency.md +85 -85
- package/skills/event-ops/templates/d-day-checklist.md +65 -65
- package/skills/event-planning/SKILL.md +132 -132
- package/skills/event-planning/rubrics/timeline.md +70 -70
- package/skills/event-planning/templates/event-plan.md +91 -91
- package/skills/exec-plan/SKILL.md +149 -149
- package/skills/exec-plan/agents/decomposer.md +47 -47
- package/skills/exec-plan/agents/dependency-mapper.md +44 -44
- package/skills/exec-plan/agents/estimator.md +43 -43
- package/skills/exec-plan/agents/validator.md +55 -55
- package/skills/exec-plan/orchestrator.md +70 -70
- package/skills/exec-plan/rubrics/complexity-scoring.md +75 -75
- package/skills/exec-plan/templates/plan.md +147 -147
- package/skills/git-worktree/SKILL.md +73 -73
- package/skills/git-worktree/rubrics/when-to-use.md +55 -55
- package/skills/handoff/SKILL.md +110 -110
- package/skills/handoff/agents/context-summarizer.md +51 -51
- package/skills/handoff/agents/document-writer.md +63 -63
- package/skills/handoff/agents/state-collector.md +53 -53
- package/skills/handoff/agents/verifier.md +48 -48
- package/skills/handoff/rubrics/completeness.md +62 -62
- package/skills/handoff/templates/handoff.md +107 -107
- package/skills/parallel-research/SKILL.md +89 -89
- package/skills/parallel-research/agents/best-practices.md +43 -43
- package/skills/parallel-research/agents/codebase-patterns.md +46 -46
- package/skills/parallel-research/agents/framework-docs.md +45 -45
- package/skills/parallel-research/agents/security-advisory.md +46 -46
- package/skills/parallel-research/agents/synthesizer.md +52 -52
- package/skills/parallel-research/experts/best-practices.md +50 -50
- package/skills/parallel-research/experts/codebase-patterns.md +70 -70
- package/skills/parallel-research/experts/framework-docs.md +65 -65
- package/skills/parallel-research/experts/security-advisory.md +69 -69
- package/skills/parallel-research/orchestrator.md +65 -65
- package/skills/parallel-research/templates/synthesis.md +101 -101
- package/skills/prioritization-frameworks/SKILL.md +87 -87
- package/skills/prioritization-frameworks/rubrics/frameworks.md +79 -79
- package/skills/prioritization-frameworks/templates/scoring-matrix.md +69 -69
- package/skills/priority-todos/SKILL.md +64 -64
- package/skills/priority-todos/rubrics/prioritization.md +70 -70
- package/skills/priority-todos/templates/todo-board.md +59 -59
- package/skills/seo-checklist/SKILL.md +58 -58
- package/skills/seo-checklist/frameworks/structured-data.md +153 -153
- package/skills/seo-checklist/rubrics/content-seo.md +42 -42
- package/skills/seo-checklist/rubrics/technical-seo.md +48 -48
- package/skills/techdebt/SKILL.md +124 -124
- package/skills/techdebt/agents/analyzer.md +50 -50
- package/skills/techdebt/agents/fixer.md +41 -41
- package/skills/techdebt/agents/reviewer.md +47 -47
- package/skills/techdebt/agents/scanner.md +44 -44
- package/skills/techdebt/orchestrator.md +70 -70
- package/skills/techdebt/rubrics/severity.md +51 -51
- package/skills/techdebt/scripts/scan.js +90 -90
- package/skills/techdebt/templates/report.md +86 -86
- package/skills/tool-fallback/SKILL.md +104 -104
- package/skills/tool-fallback/rubrics/fallback-chain.md +58 -58
- package/skills/typescript-advanced-types/SKILL.md +67 -67
- package/skills/typescript-advanced-types/rubrics/type-patterns.md +109 -109
- package/skills/ui-ux-pro-max/SKILL.md +236 -236
- package/skills/ui-ux-pro-max/reference/color-and-contrast.md +517 -517
- package/skills/ui-ux-pro-max/reference/interaction-design.md +544 -544
- package/skills/ui-ux-pro-max/reference/motion-design.md +591 -591
- package/skills/ui-ux-pro-max/reference/responsive-design.md +463 -463
- package/skills/ui-ux-pro-max/reference/spatial-design.md +390 -390
- package/skills/ui-ux-pro-max/reference/typography.md +455 -455
- package/skills/ui-ux-pro-max/reference/ux-writing.md +469 -469
- package/skills/ui-ux-pro-max/rubrics/interaction-states.md +83 -83
- package/skills/ui-ux-pro-max/rubrics/responsive-breakpoints.md +99 -99
- package/skills/user-personas/SKILL.md +75 -75
- package/skills/user-personas/rubrics/research-methods.md +56 -56
- package/skills/user-personas/templates/persona.md +89 -89
- package/skills/vercel-react-best-practices/SKILL.md +60 -60
- package/skills/vercel-react-best-practices/rubrics/performance.md +82 -82
- package/skills/vercel-react-best-practices/rubrics/server-components.md +86 -86
- package/skills/vibe.docs/SKILL.md +171 -171
- package/skills/vibe.docs/templates/architecture.md +80 -80
- package/skills/vibe.docs/templates/readme.md +84 -84
- package/skills/vibe.docs/templates/release-notes.md +74 -74
- package/skills/vibe.figma/SKILL.md +215 -982
- package/skills/vibe.figma/rubrics/extraction-checklist.md +51 -51
- package/skills/vibe.figma/templates/component-index.md +126 -126
- package/skills/vibe.figma/templates/figma-handoff.md +100 -100
- package/skills/vibe.figma/templates/remapped-tree.md +277 -277
- package/skills/vibe.figma.convert/SKILL.md +188 -511
- package/skills/vibe.figma.convert/rubrics/conversion-rules.md +129 -113
- package/skills/vibe.figma.convert/templates/component.md +140 -140
- package/skills/vibe.figma.extract/SKILL.md +179 -300
- package/skills/vibe.figma.extract/rubrics/image-rules.md +145 -137
- package/skills/video-production/SKILL.md +52 -52
- package/skills/video-production/rubrics/quality-checklist.md +58 -58
- package/skills/video-production/templates/production-plan.md +104 -104
- package/vibe/config.json +29 -29
- package/vibe/constitution.md +227 -227
- package/vibe/rules/principles/communication-guide.md +98 -98
- package/vibe/rules/principles/development-philosophy.md +52 -52
- package/vibe/rules/principles/quick-start.md +102 -102
- package/vibe/rules/quality/bdd-contract-testing.md +393 -393
- package/vibe/rules/quality/checklist.md +276 -276
- package/vibe/rules/quality/performance.md +236 -236
- package/vibe/rules/quality/testing-strategy.md +440 -440
- package/vibe/rules/standards/anti-patterns.md +541 -541
- package/vibe/rules/standards/code-structure.md +291 -291
- package/vibe/rules/standards/complexity-metrics.md +313 -313
- package/vibe/rules/standards/git-workflow.md +237 -237
- package/vibe/rules/standards/naming-conventions.md +198 -198
- package/vibe/rules/standards/security.md +305 -305
- package/vibe/rules/writing/document-style.md +74 -74
- package/vibe/setup.sh +31 -31
- package/vibe/templates/constitution-template.md +252 -252
- package/vibe/templates/contract-backend-template.md +526 -526
- package/vibe/templates/contract-frontend-template.md +599 -599
- package/vibe/templates/feature-template.md +96 -96
- package/vibe/templates/spec-template.md +221 -221
- package/vibe/ui-ux-data/charts.csv +26 -26
- package/vibe/ui-ux-data/colors.csv +97 -97
- package/vibe/ui-ux-data/icons.csv +101 -101
- package/vibe/ui-ux-data/landing.csv +31 -31
- package/vibe/ui-ux-data/products.csv +96 -96
- package/vibe/ui-ux-data/react-performance.csv +45 -45
- package/vibe/ui-ux-data/stacks/astro.csv +54 -54
- package/vibe/ui-ux-data/stacks/flutter.csv +53 -53
- package/vibe/ui-ux-data/stacks/html-tailwind.csv +56 -56
- package/vibe/ui-ux-data/stacks/jetpack-compose.csv +53 -53
- package/vibe/ui-ux-data/stacks/nextjs.csv +53 -53
- package/vibe/ui-ux-data/stacks/nuxt-ui.csv +51 -51
- package/vibe/ui-ux-data/stacks/nuxtjs.csv +59 -59
- package/vibe/ui-ux-data/stacks/react-native.csv +52 -52
- package/vibe/ui-ux-data/stacks/react.csv +54 -54
- package/vibe/ui-ux-data/stacks/shadcn.csv +61 -61
- package/vibe/ui-ux-data/stacks/svelte.csv +54 -54
- package/vibe/ui-ux-data/stacks/swiftui.csv +51 -51
- package/vibe/ui-ux-data/stacks/vue.csv +50 -50
- package/vibe/ui-ux-data/styles.csv +68 -68
- package/vibe/ui-ux-data/typography.csv +57 -57
- package/vibe/ui-ux-data/ui-reasoning.csv +101 -101
- package/vibe/ui-ux-data/ux-guidelines.csv +99 -99
- package/vibe/ui-ux-data/version.json +31 -31
- package/vibe/ui-ux-data/web-interface.csv +31 -31
|
@@ -1,351 +1,351 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: claude-md-guide
|
|
3
|
-
tier: standard
|
|
4
|
-
description: "Guide for writing effective CLAUDE.md files from scratch. Evidence-based methodology from 40+ sources including research papers, official docs, and real-world examples. Covers 3-layer architecture, Curse of Instructions mitigation, progressive disclosure, and maintenance. Use when creating new CLAUDE.md, improving existing ones, or teaching team members how to write project instructions for AI agents."
|
|
5
|
-
triggers: [claude-md guide, write claude.md, create claude.md, claude.md ์์ฑ, ํด๋ก๋ ๋ฌธ์, project instructions, claude-md]
|
|
6
|
-
priority: 55
|
|
7
|
-
chain-next: [agents-md]
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
# claude-md-guide โ CLAUDE.md ์์ฑ ๊ฐ์ด๋
|
|
11
|
-
|
|
12
|
-
> **์์น**: "์์ด์ ํธ๊ฐ ์ด๊ฑธ ๋ชจ๋ฅด๋ฉด ์ค์ํ ๊น?" โ No๋ฉด ์ญ์ . Yes๋ฉด ์ ์ง.
|
|
13
|
-
|
|
14
|
-
## Why This Matters
|
|
15
|
-
|
|
16
|
-
์ฐ๊ตฌ ๊ฒฐ๊ณผ์ ๋ฐ๋ฅด๋ฉด ์ง์์ฌํญ์ด ๋ง์์ง์๋ก LLM์ ์ค์์จ์ด **์ง์์ ์ผ๋ก** ํ๋ฝํฉ๋๋ค (Curse of Instructions):
|
|
17
|
-
|
|
18
|
-
| ์ง์ ์ | GPT-4o ์ค์์จ | Claude Sonnet ์ค์์จ |
|
|
19
|
-
|---------|--------------|---------------------|
|
|
20
|
-
| 1๊ฐ | ~85% | ~90% |
|
|
21
|
-
| 5๊ฐ | ~44% | ~59% |
|
|
22
|
-
| 10๊ฐ | ~15% | ~44% |
|
|
23
|
-
| 15๊ฐ+ | ~5% | ~15% |
|
|
24
|
-
|
|
25
|
-
**๊ฒฐ๋ก **: ๋ชจ๋ ์ค์ด ๋น์ฉ. ์งง๊ณ ์ ํํ CLAUDE.md๊ฐ ๊ธธ๊ณ ํฌ๊ด์ ์ธ ๊ฒ๋ณด๋ค ๋ซ์ต๋๋ค.
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
## Step 1: ํ๋ก์ ํธ ํ์ โ ์๋ ์์ง
|
|
30
|
-
|
|
31
|
-
CLAUDE.md๋ฅผ ์์ฑํ๊ธฐ ์ ์ ๋จผ์ ํ๋ก์ ํธ๋ฅผ ํ์ํฉ๋๋ค:
|
|
32
|
-
|
|
33
|
-
```
|
|
34
|
-
Glob: pattern="package.json" โ ์คํ, ์คํฌ๋ฆฝํธ ํ์ธ
|
|
35
|
-
Glob: pattern="*.config.*" โ ๋น๋/๋ฆฐํธ ์ค์
|
|
36
|
-
Glob: pattern="tsconfig.json" โ TypeScript ์ค์
|
|
37
|
-
Glob: pattern=".env.example" โ ํ๊ฒฝ๋ณ์ ๊ตฌ์กฐ
|
|
38
|
-
Glob: pattern="Makefile" โ ๋น๋ ์์คํ
|
|
39
|
-
Glob: pattern="docker-compose.*" โ ์ธํ๋ผ ๊ตฌ์กฐ
|
|
40
|
-
Glob: pattern="CLAUDE.md" โ ๊ธฐ์กด ํ์ผ ํ์ธ
|
|
41
|
-
Glob: pattern="AGENTS.md" โ ํธํ ํ์ผ ํ์ธ
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
์์งํ ์ ๋ณด๋ฅผ ์ฌ์ฉ์์๊ฒ ์์ฝ ์ ์ํ๊ณ , ๋น ์ง ์ปจํ
์คํธ๋ฅผ ์ง๋ฌธํฉ๋๋ค.
|
|
45
|
-
|
|
46
|
-
## Step 2: ์ธํฐ๋ทฐ โ ๋น๋ฐ๊ฒฌ์ ์ ๋ณด ์ถ์ถ
|
|
47
|
-
|
|
48
|
-
์๋ ํ์์ผ๋ก ์ ์ ์๋ ์ ๋ณด๋ง ์ง๋ฌธํฉ๋๋ค. **ํ ๋ฒ์ ์ง๋ฌธ ํ๋, ๊ฐ๋ฅํ๋ฉด ๊ฐ๊ด์**์ผ๋ก:
|
|
49
|
-
|
|
50
|
-
### ์ง๋ฌธ ์นดํ
๊ณ ๋ฆฌ
|
|
51
|
-
|
|
52
|
-
**1. ๋ฐํ์ ํจ์ (Runtime Traps)**
|
|
53
|
-
- ์ฝ๋์์ ๋ณด์ด์ง ์๋ ๋ฐํ์ ์ฐจ์ด๊ฐ ์๋์? (์: Bun vs Node, ESM vs CJS)
|
|
54
|
-
- ํน์ ํ๊ฒฝ์์๋ง ๋ฐ์ํ๋ ๋ฒ๊ทธ๊ฐ ์๋์?
|
|
55
|
-
|
|
56
|
-
**2. ๊ธ์ง ํจํด (Forbidden Patterns)**
|
|
57
|
-
- ์ ๋ ์ฌ์ฉํ๋ฉด ์ ๋๋ ๋ผ์ด๋ธ๋ฌ๋ฆฌ/ํจํด์ด ์๋์?
|
|
58
|
-
- ๊ณผ๊ฑฐ์ ๋ฌธ์ ๋ฅผ ์ผ์ผํจ ์ ๊ทผ๋ฒ์ด ์๋์?
|
|
59
|
-
|
|
60
|
-
**3. ๋นํ์ค ๊ด๋ก (Non-standard Conventions)**
|
|
61
|
-
- ํ์ค๊ณผ ๋ค๋ฅธ ๋ค์ด๋ฐ/๊ตฌ์กฐ ๊ท์น์ด ์๋์?
|
|
62
|
-
- ํ์์ ํฉ์ํ ํน์ํ ์ํฌํ๋ก์ฐ๊ฐ ์๋์?
|
|
63
|
-
|
|
64
|
-
**4. ์ํคํ
์ฒ ๊ฒฐ์ (Architecture Decisions)**
|
|
65
|
-
- ์ฝ๋๋ง ๋ด์๋ ์ ์ ์๋ ์ค๊ณ ์ด์ ๊ฐ ์๋์?
|
|
66
|
-
- ํน์ ํจํด์ ์ ํํ ๋น์ฆ๋์ค ๋งฅ๋ฝ์ด ์๋์?
|
|
67
|
-
|
|
68
|
-
**5. ๊ฒฝ๊ณ์ (Boundaries)**
|
|
69
|
-
- ์์ด์ ํธ๊ฐ ์ ๋ ๊ฑด๋๋ฆฌ๋ฉด ์ ๋๋ ํ์ผ/๋๋ ํ ๋ฆฌ๊ฐ ์๋์?
|
|
70
|
-
- ๋ณ๊ฒฝ ์ ๋ฐ๋์ ํ์ธ๋ฐ์์ผ ํ๋ ์์ญ์ด ์๋์?
|
|
71
|
-
|
|
72
|
-
## Step 3: ๊ตฌ์กฐ ์ค๊ณ โ 3-Layer Architecture
|
|
73
|
-
|
|
74
|
-
์์งํ ์ ๋ณด๋ฅผ 3๊ฐ ๋ ์ด์ด๋ก ๋ถ๋ฆฌํฉ๋๋ค:
|
|
75
|
-
|
|
76
|
-
### Layer 1: CLAUDE.md (ํ๋ก์ ํธ ํ๋ฒ)
|
|
77
|
-
|
|
78
|
-
**๋ชจ๋ ์ธ์
์ ์๋ ๋ก๋** โ ๋ณดํธ์ ์ด๊ณ ์์ ์ ์ธ ์ ๋ณด๋ง.
|
|
79
|
-
|
|
80
|
-
```markdown
|
|
81
|
-
# {ํ๋ก์ ํธ๋ช
}
|
|
82
|
-
|
|
83
|
-
{ํ๋ก์ ํธ๊ฐ ๋ญ์ง 1-2๋ฌธ์ฅ. ์ฝ๋์์ ๋ชฉ์ ์ด ๋ถ๋ถ๋ช
ํ ๋๋ง.}
|
|
84
|
-
|
|
85
|
-
## Tech Stack
|
|
86
|
-
{package.json์์ ๋ฐ๋ก ์ ์ ์๋ ๊ฒ๋ง. ์: "Bun runtime (not Node)"}
|
|
87
|
-
|
|
88
|
-
## Commands
|
|
89
|
-
{package.json scripts์ ์๊ฑฐ๋ ๋น์ง๊ด์ ์ธ ๊ฒ๋ง}
|
|
90
|
-
- `npm run build && npx vitest run` โ ๋น๋ ํ ํ
์คํธ (์์ ์ค์)
|
|
91
|
-
|
|
92
|
-
## Conventions
|
|
93
|
-
{๋ฆฐํฐ๊ฐ ์ก์ง ๋ชปํ๋ ๊ฒ๋ง}
|
|
94
|
-
- ESM only โ imports need `.js` extension
|
|
95
|
-
- {๋นํ์ค ๋ค์ด๋ฐ ๊ท์น์ด ์๋ค๋ฉด}
|
|
96
|
-
|
|
97
|
-
## Gotchas
|
|
98
|
-
{์์ด์ ํธ๊ฐ ๋ฐ๋ณต์ ์ผ๋ก ์ค์ํ ๊ฒ๋ค}
|
|
99
|
-
- **{ํจ์ ์ ๋ชฉ}.** {๊ตฌ์ฒด์ ์ธ do/don't ์ค๋ช
}
|
|
100
|
-
|
|
101
|
-
## Boundaries
|
|
102
|
-
โ
Always: {ํญ์ ํด์ผ ํ๋ ๊ฒ}
|
|
103
|
-
โ ๏ธ Ask first: {๋จผ์ ํ์ธ๋ฐ์์ผ ํ๋ ๊ฒ}
|
|
104
|
-
๐ซ Never: {์ ๋ ํ๋ฉด ์ ๋๋ ๊ฒ}
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
### Layer 2: SPEC.md (๊ธฐ๋ฅ๋ณ ์ค๊ณ ๋ฌธ์)
|
|
108
|
-
|
|
109
|
-
**ํน์ ๊ธฐ๋ฅ ์์
์์๋ง ๋ก๋** โ what๊ณผ why์ ์ง์ค, how๋ ์์ด์ ํธ์๊ฒ.
|
|
110
|
-
|
|
111
|
-
์ ์ฅ ์์น: `.claude/vibe/specs/YYYY-MM-DD-{์ฃผ์ }.md`
|
|
112
|
-
|
|
113
|
-
```markdown
|
|
114
|
-
# {๊ธฐ๋ฅ๋ช
} SPEC
|
|
115
|
-
|
|
116
|
-
## ๋ชฉ์ (Why)
|
|
117
|
-
## ์๊ตฌ์ฌํญ (What)
|
|
118
|
-
## ์ฑ๊ณต ๊ธฐ์ค (Acceptance Criteria)
|
|
119
|
-
## ๊ธฐ์ ์ ์ ์ฝ (Constraints)
|
|
120
|
-
## ๊ฒฝ๊ณ์ (Out of Scope)
|
|
121
|
-
```
|
|
122
|
-
|
|
123
|
-
### Layer 3: plan.md (์คํ ๊ณํ)
|
|
124
|
-
|
|
125
|
-
**์ธ์
๋ณ ํ์คํฌ ๋ฆฌ์คํธ** โ 2-5๋ถ ๋จ์, ํ์ผ ๊ฒฝ๋ก ๋ช
์.
|
|
126
|
-
|
|
127
|
-
์ ์ฅ ์์น: `.claude/vibe/specs/{name}-execplan.md`
|
|
128
|
-
|
|
129
|
-
```markdown
|
|
130
|
-
# Execution Plan
|
|
131
|
-
|
|
132
|
-
## Task 1: {์ ๋ชฉ}
|
|
133
|
-
- Files: `src/foo.ts`, `src/foo.test.ts`
|
|
134
|
-
- Action: {๊ตฌ์ฒด์ ๋ณ๊ฒฝ ๋ด์ฉ}
|
|
135
|
-
- Verify: `npm test src/foo.test.ts`
|
|
136
|
-
|
|
137
|
-
## Task 2: ...
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
## Step 4: ์์ฑ โ ์ฆ๊ฑฐ ๊ธฐ๋ฐ ์์น ์ ์ฉ
|
|
141
|
-
|
|
142
|
-
### ํฌ๊ธฐ ์ ํ
|
|
143
|
-
|
|
144
|
-
| ๋ฑ๊ธ | ์ค ์ | ์ ํฉํ ๊ฒฝ์ฐ |
|
|
145
|
-
|------|-------|------------|
|
|
146
|
-
| ์ต์ | 60-150์ค | ๋๋ถ๋ถ์ ํ๋ก์ ํธ |
|
|
147
|
-
| ํ์ฉ | 150-200์ค | ๋ณต์กํ ๋ชจ๋
ธ๋ ํฌ |
|
|
148
|
-
| ๊ฒฝ๊ณ | 200-300์ค | ๋ถ๋ฆฌ ํ์ |
|
|
149
|
-
| ์ํ | 300์ค+ | ์์ด์ ํธ๊ฐ ์ ๋ฐ ๋ฌด์ |
|
|
150
|
-
|
|
151
|
-
### ์์น๋ณ ์ฃผ์๋ ฅ ๋ถํฌ (Lost in the Middle ํจ๊ณผ)
|
|
152
|
-
|
|
153
|
-
LLM์ ๋ฌธ์์ **์ฒ์๊ณผ ๋**์ ์ง์คํ๊ณ **์ค๊ฐ์ ๋ฌด์**ํฉ๋๋ค:
|
|
154
|
-
|
|
155
|
-
```
|
|
156
|
-
์ฃผ์๋ ฅ: โโโโโโโโโโโโโโโโโโโโโโโโ
|
|
157
|
-
^์์ ^์ค๊ฐ(โ20-40%) ^๋
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
**๋์**:
|
|
161
|
-
- **๊ฐ์ฅ ์ค์ํ ๊ท์น** โ ๋ฌธ์ ์๋จ์ ๋ฐฐ์น
|
|
162
|
-
- **์์ฃผ ์๋ฐ๋๋ ๊ท์น** โ ๋ฌธ์ ํ๋จ(๋)์ ๋ฐฐ์น
|
|
163
|
-
- **๋ฐฐ๊ฒฝ ์ ๋ณด** โ ์ค๊ฐ์ ๋ฐฐ์น (๋ฌด์๋์ด๋ ๊ด์ฐฎ์ ๊ฒ)
|
|
164
|
-
|
|
165
|
-
### ํฌํจ vs ์ ์ธ ์ฒดํฌ๋ฆฌ์คํธ
|
|
166
|
-
|
|
167
|
-
**โ
ํฌํจ (๋น๋ฐ๊ฒฌ์ , ์ด์์ ์ค์)**
|
|
168
|
-
|
|
169
|
-
| ์ ํ | ์์ |
|
|
170
|
-
|------|------|
|
|
171
|
-
| ๋ฐํ์ ํจ์ | "Bun runtime, not Node" |
|
|
172
|
-
| ๊ธ์ง ํจํด | "Never use `any`, use `unknown` + type guards" |
|
|
173
|
-
| SSOT ์์น | "Only edit `constants.ts` for stack mapping" |
|
|
174
|
-
| ์์ ๋ถ๋ณ ๊ท์น | "Build before test, always" |
|
|
175
|
-
| ๋นํ์ค ์ปค๋งจ๋ | ๋ณตํฉ ๋ช
๋ น์ด, ํน์ ํ๋๊ทธ |
|
|
176
|
-
| ๋ณด์ ๊ท์น | ์ธ์ฆ, ๊ฒฝ๋ก ์ํ ๋ฐฉ์ง ๋ฑ |
|
|
177
|
-
|
|
178
|
-
**โ ์ ์ธ (๋ฐ๊ฒฌ ๊ฐ๋ฅํ๊ฑฐ๋ ๋ค๋ฅธ ๋๊ตฌ์ ๋งก๊ธธ ๊ฒ)**
|
|
179
|
-
|
|
180
|
-
| ์ ํ | ์ด์ | ๋์ |
|
|
181
|
-
|------|------|------|
|
|
182
|
-
| ๋๋ ํ ๋ฆฌ ๊ตฌ์กฐ | `ls`๋ก ๋ฐ๊ฒฌ ๊ฐ๋ฅ | ์ฝ๋ ์์ฒด |
|
|
183
|
-
| ๊ธฐ์ ์คํ ๋ชฉ๋ก | `package.json`์ ์์ | ์ฝ๋ ์์ฒด |
|
|
184
|
-
| ์ฝ๋ ์คํ์ผ (๋ค์ฌ์ฐ๊ธฐ, ์ธ๋ฏธ์ฝ๋ก ) | ๋ฆฐํฐ๊ฐ ์ก์ | ESLint, Prettier |
|
|
185
|
-
| API ๋ฌธ์ | ์ฝ๋์์ ์ฝ์ ์ ์์ | Swagger, JSDoc |
|
|
186
|
-
| ์ผ๋ฐ์ Best Practice | LLM์ด ์ด๋ฏธ ์ | ๋ถํ์ |
|
|
187
|
-
| API ํค, ์ํฌ๋ฆฟ | ๋น ๋ฅด๊ฒ ๊ตฌ์์ด ๋จ | `.env`, vault |
|
|
188
|
-
| ๊ธฐ๋ฅ๋ณ ์์ธ ์ง์ | Layer 2๋ก ๋ถ๋ฆฌ | SPEC.md |
|
|
189
|
-
|
|
190
|
-
### ๊ฐ์กฐ ๊ธฐ๋ฒ
|
|
191
|
-
|
|
192
|
-
์ค์ํ ๊ท์น์ด ๋ฌด์๋ ๋ ์ฌ์ฉ:
|
|
193
|
-
|
|
194
|
-
```markdown
|
|
195
|
-
**IMPORTANT**: {critical rule}
|
|
196
|
-
**MUST**: {mandatory action}
|
|
197
|
-
**NEVER**: {absolute prohibition}
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
๋จ, ๋ชจ๋ ์ค์ ๊ฐ์กฐ๋ฅผ ๋ฃ์ผ๋ฉด **๊ฐ์กฐ๊ฐ ๋ฌดํจํ**๋ฉ๋๋ค. P1 ๊ท์น์๋ง ์ฌ์ฉํ์ธ์.
|
|
201
|
-
|
|
202
|
-
### Progressive Disclosure (์ ์ง์ ๊ณต๊ฐ)
|
|
203
|
-
|
|
204
|
-
CLAUDE.md์ ๋ชจ๋ ๊ฒ์ ๋ฃ์ง ๋ง๊ณ ์ฐธ์กฐํ์ธ์:
|
|
205
|
-
|
|
206
|
-
```markdown
|
|
207
|
-
# Architecture
|
|
208
|
-
See @docs/ARCHITECTURE.md for design decisions.
|
|
209
|
-
|
|
210
|
-
# Security
|
|
211
|
-
@.claude/rules/security.md
|
|
212
|
-
```
|
|
213
|
-
|
|
214
|
-
Claude Code๋ `@` ์ฐธ์กฐ๋ฅผ ๋ฐ๋ผ๊ฐ์ ํ์ํ ๋๋ง ๋ก๋ํฉ๋๋ค.
|
|
215
|
-
|
|
216
|
-
## Step 5: ๊ฒ์ฆ โ ์์ฑ ํ์ง ์ฒดํฌ
|
|
217
|
-
|
|
218
|
-
์์ฑ๋ CLAUDE.md๋ฅผ ๊ฒ์ฆํฉ๋๋ค:
|
|
219
|
-
|
|
220
|
-
### ์ค๋ณ ๊ฒ์ฆ
|
|
221
|
-
|
|
222
|
-
๋ชจ๋ ์ค์ ๋ํด 4๊ฐ์ง ์ง๋ฌธ:
|
|
223
|
-
|
|
224
|
-
1. **์ด๊ฑธ ๋นผ๋ฉด ์์ด์ ํธ๊ฐ ์ค์ํ ๊น?** โ No๋ฉด ์ญ์
|
|
225
|
-
2. **๋ชจ๋ ์ธ์
์ ํ์ํ๊ฐ?** โ No๋ฉด Layer 2/3์ผ๋ก ์ด๋
|
|
226
|
-
3. **๋ฆฐํฐ/ํ
์ด ๋์ ํ ์ ์๋?** โ Yes๋ฉด ๋ฆฐํฐ/ํ
์ผ๋ก ์ด๋
|
|
227
|
-
4. **์ฝ๋์์ ๋ฐ๊ฒฌ ๊ฐ๋ฅํ๊ฐ?** โ Yes๋ฉด ์ญ์
|
|
228
|
-
|
|
229
|
-
### ์ต์ปค๋ง ๊ฒฝ๊ณ
|
|
230
|
-
|
|
231
|
-
๊ธฐ์ ๋ช
์ ์ธ๊ธํ๋ฉด ์์ด์ ํธ๊ฐ ๊ทธ์ชฝ์ผ๋ก ํธํฅ๋ฉ๋๋ค:
|
|
232
|
-
- โ "We use React" โ ๋ถํ์ (package.json์ ์์)
|
|
233
|
-
- โ
"Never use jQuery, even for legacy code" โ ์ ์ฉ (ํจ์ ๋ฐฉ์ง)
|
|
234
|
-
|
|
235
|
-
### ํ ํฐ ํจ์จ์ฑ
|
|
236
|
-
|
|
237
|
-
| ๋ฌธ์ | ์์ | ๊ฐ์ |
|
|
238
|
-
|------|------|------|
|
|
239
|
-
| ์ฅํฉํ ์ค๋ช
| "Please always make sure to..." | "Always:" |
|
|
240
|
-
| ์ค๋ณต | ๊ฐ์ ๊ท์น์ ๋ค๋ฅธ ํํ์ผ๋ก ๋ฐ๋ณต | ํ ๋ฒ๋ง |
|
|
241
|
-
| ๋ถํ์ํ ๋งฅ๋ฝ | "As we discussed..." | ์ญ์ |
|
|
242
|
-
|
|
243
|
-
## Step 6: ์ ์ง๋ณด์ โ ์ด์์๋ ๋ฌธ์
|
|
244
|
-
|
|
245
|
-
### ์ ์ง์ ์ถ๊ฐ ํจํด
|
|
246
|
-
|
|
247
|
-
์ฒ์๋ถํฐ ์๋ฒฝํ๊ฒ ์ฐ์ง ๋ง์ธ์:
|
|
248
|
-
|
|
249
|
-
```
|
|
250
|
-
1. ์ต์ํ์ CLAUDE.md๋ก ์์ (30-50์ค)
|
|
251
|
-
2. ์์ด์ ํธ๊ฐ ์ค์ํ๋ ๊ฑธ ๊ด์ฐฐ
|
|
252
|
-
3. ๋ฐ๋ณต๋๋ ์ค์๋ง ๊ท์น์ผ๋ก ์ถ๊ฐ
|
|
253
|
-
4. 2-3์ฃผ๋ง๋ค ๋ถํ์ํ ์ค ์ ๋ฆฌ
|
|
254
|
-
```
|
|
255
|
-
|
|
256
|
-
### Reflection Loop (Addy Osmani ํจํด)
|
|
257
|
-
|
|
258
|
-
```
|
|
259
|
-
์์ด์ ํธ ์์
์๋ฃ
|
|
260
|
-
โ "๋ฌด์์ด ์์๊ณผ ๋ฌ๋๋?" ์๋ฌธ
|
|
261
|
-
โ ๋ฐ๋ณต๋๋ ํจํด ๋ฐ๊ฒฌ ์ CLAUDE.md์ 1์ค ์ถ๊ฐ
|
|
262
|
-
โ ๊ทผ๋ณธ ์์ธ์ด ์ฝ๋ ๊ตฌ์กฐ๋ฉด ์ฝ๋๋ฅผ ๊ณ ์น๊ณ ๊ท์น์ ์ถ๊ฐํ์ง ์์
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
### ์ํ ์ ํธ
|
|
266
|
-
|
|
267
|
-
| ์ ํธ | ์๋ฏธ | ๋์ |
|
|
268
|
-
|------|------|------|
|
|
269
|
-
| 300์ค ์ด๊ณผ | ์ ๋ณด ๊ณผ๋ถํ | ๋ถ๋ฆฌ ๋๋ ์ ๋ฆฌ |
|
|
270
|
-
| ๊ฐ์ ์ค์ ๋ฐ๋ณต | ๊ท์น์ด ๋
ธ์ด์ฆ์ ๋ฌปํ | ๊ฐ์กฐ ๋๋ ํตํฉ |
|
|
271
|
-
| ๊ท์น ์ถ๊ฐํด๋ ๋ณํ ์์ | ํ์ผ์ด ๋๋ฌด ๊น | ๊ทผ๋ณธ ์์ธ ์์ |
|
|
272
|
-
| ํ์์ด ๊ท์น ๋ฌด์ | ๋ฐ๊ฒฌ ๊ฐ๋ฅํ ์ ๋ณด | ์ญ์ |
|
|
273
|
-
|
|
274
|
-
---
|
|
275
|
-
|
|
276
|
-
## Quick Reference: ํ๋ก์ ํธ ๊ท๋ชจ๋ณ ๊ฐ์ด๋
|
|
277
|
-
|
|
278
|
-
### ์๊ท๋ชจ (ํ์ผ 10๊ฐ ๋ฏธ๋ง)
|
|
279
|
-
|
|
280
|
-
```markdown
|
|
281
|
-
# {ํ๋ก์ ํธ๋ช
}
|
|
282
|
-
|
|
283
|
-
## Commands
|
|
284
|
-
- `{build}` โ {์ค๋ช
}
|
|
285
|
-
- `{test}` โ {์ค๋ช
}
|
|
286
|
-
|
|
287
|
-
## Gotchas
|
|
288
|
-
- **{ํจ์ 1}.** {์ค๋ช
}
|
|
289
|
-
- **{ํจ์ 2}.** {์ค๋ช
}
|
|
290
|
-
|
|
291
|
-
## Never
|
|
292
|
-
- ๐ซ {๊ธ์ง ์ฌํญ}
|
|
293
|
-
```
|
|
294
|
-
|
|
295
|
-
**๋ชฉํ: 20-30์ค**
|
|
296
|
-
|
|
297
|
-
### ์ค๊ท๋ชจ (ํ์ผ 10-50๊ฐ)
|
|
298
|
-
|
|
299
|
-
์ + Conventions, Boundaries ์น์
์ถ๊ฐ.
|
|
300
|
-
|
|
301
|
-
**๋ชฉํ: 60-150์ค**
|
|
302
|
-
|
|
303
|
-
### ๋๊ท๋ชจ (ํ์ผ 50๊ฐ+, ๋ชจ๋
ธ๋ ํฌ)
|
|
304
|
-
|
|
305
|
-
๋ฃจํธ CLAUDE.md (๊ณตํต ๊ท์น) + ํ์ ๋๋ ํ ๋ฆฌ๋ณ CLAUDE.md.
|
|
306
|
-
|
|
307
|
-
```
|
|
308
|
-
project/
|
|
309
|
-
โโโ CLAUDE.md โ ๊ณตํต (60์ค)
|
|
310
|
-
โโโ packages/api/CLAUDE.md โ API ์ ์ฉ (30์ค)
|
|
311
|
-
โโโ packages/web/CLAUDE.md โ ์น ์ ์ฉ (30์ค)
|
|
312
|
-
โโโ .claude/rules/ โ ๊ฒฝ๋ก๋ณ ๊ท์น
|
|
313
|
-
โโโ security.md
|
|
314
|
-
โโโ testing.md
|
|
315
|
-
```
|
|
316
|
-
|
|
317
|
-
**๋ชฉํ: ๋ฃจํธ 100์ค + ํ์ ๊ฐ 30์ค**
|
|
318
|
-
|
|
319
|
-
---
|
|
320
|
-
|
|
321
|
-
## ์ธ์
๋ถ๋ฆฌ ์์น
|
|
322
|
-
|
|
323
|
-
CLAUDE.md ์์ฑ๋ ์ธ์
์ ๋ถ๋ฆฌํ๋ฉด ํ์ง์ด ์ฌ๋ผ๊ฐ๋๋ค:
|
|
324
|
-
|
|
325
|
-
| ์ธ์
| ๋ชฉํ | ์ฐ์ถ๋ฌผ |
|
|
326
|
-
|------|------|--------|
|
|
327
|
-
| ์ธ์
1 | ํ๋ก์ ํธ ํ์ + ์ธํฐ๋ทฐ | ์ด์ |
|
|
328
|
-
| ์ธ์
2 | ๊ฒ์ฆ + ์ต์ ํ | ์ต์ข
๋ณธ |
|
|
329
|
-
| ์ดํ | ์ ์ง์ ์ ์ง๋ณด์ | ์ง์ ๊ฐ์ |
|
|
330
|
-
|
|
331
|
-
์์ฑ ์๋ฃ ํ: `โ /agents-md` ์คํฌ๋ก ์ต์ ํ ๊ฒ์ฆ์ ์คํํ์ธ์.
|
|
332
|
-
|
|
333
|
-
---
|
|
334
|
-
|
|
335
|
-
## References
|
|
336
|
-
|
|
337
|
-
### Research
|
|
338
|
-
- [Curse of Instructions: LLMs Cannot Follow Multiple Instructions at Once](https://openreview.net/forum?id=R6q67CDBCH)
|
|
339
|
-
- [Lost in the Middle: How Language Models Use Long Contexts](https://arxiv.org/abs/2307.03172)
|
|
340
|
-
- [The Instruction Hierarchy: Training LLMs to Prioritize Privileged Instructions](https://arxiv.org/html/2404.13208v1)
|
|
341
|
-
- [Context Length Alone Hurts LLM Performance Despite Perfect Retrieval](https://arxiv.org/html/2510.05381v1)
|
|
342
|
-
|
|
343
|
-
### Official Docs
|
|
344
|
-
- [Claude Code Best Practices](https://code.claude.com/docs/en/best-practices)
|
|
345
|
-
- [Using CLAUDE.md Files](https://claude.com/blog/using-claude-md-files)
|
|
346
|
-
|
|
347
|
-
### Community
|
|
348
|
-
- [Addy Osmani: AGENTS.md](https://addyosmani.com/blog/agents-md/)
|
|
349
|
-
- [HumanLayer: Writing a good CLAUDE.md](https://www.humanlayer.dev/blog/writing-a-good-claude-md)
|
|
350
|
-
- [Builder.io: CLAUDE.md Guide](https://www.builder.io/blog/claude-md-guide)
|
|
351
|
-
- [GitHub Blog: How to Write a Great agents.md](https://github.blog/ai-and-ml/github-copilot/how-to-write-a-great-agents-md-lessons-from-over-2500-repositories/)
|
|
1
|
+
---
|
|
2
|
+
name: claude-md-guide
|
|
3
|
+
tier: standard
|
|
4
|
+
description: "Guide for writing effective CLAUDE.md files from scratch. Evidence-based methodology from 40+ sources including research papers, official docs, and real-world examples. Covers 3-layer architecture, Curse of Instructions mitigation, progressive disclosure, and maintenance. Use when creating new CLAUDE.md, improving existing ones, or teaching team members how to write project instructions for AI agents."
|
|
5
|
+
triggers: [claude-md guide, write claude.md, create claude.md, claude.md ์์ฑ, ํด๋ก๋ ๋ฌธ์, project instructions, claude-md]
|
|
6
|
+
priority: 55
|
|
7
|
+
chain-next: [agents-md]
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# claude-md-guide โ CLAUDE.md ์์ฑ ๊ฐ์ด๋
|
|
11
|
+
|
|
12
|
+
> **์์น**: "์์ด์ ํธ๊ฐ ์ด๊ฑธ ๋ชจ๋ฅด๋ฉด ์ค์ํ ๊น?" โ No๋ฉด ์ญ์ . Yes๋ฉด ์ ์ง.
|
|
13
|
+
|
|
14
|
+
## Why This Matters
|
|
15
|
+
|
|
16
|
+
์ฐ๊ตฌ ๊ฒฐ๊ณผ์ ๋ฐ๋ฅด๋ฉด ์ง์์ฌํญ์ด ๋ง์์ง์๋ก LLM์ ์ค์์จ์ด **์ง์์ ์ผ๋ก** ํ๋ฝํฉ๋๋ค (Curse of Instructions):
|
|
17
|
+
|
|
18
|
+
| ์ง์ ์ | GPT-4o ์ค์์จ | Claude Sonnet ์ค์์จ |
|
|
19
|
+
|---------|--------------|---------------------|
|
|
20
|
+
| 1๊ฐ | ~85% | ~90% |
|
|
21
|
+
| 5๊ฐ | ~44% | ~59% |
|
|
22
|
+
| 10๊ฐ | ~15% | ~44% |
|
|
23
|
+
| 15๊ฐ+ | ~5% | ~15% |
|
|
24
|
+
|
|
25
|
+
**๊ฒฐ๋ก **: ๋ชจ๋ ์ค์ด ๋น์ฉ. ์งง๊ณ ์ ํํ CLAUDE.md๊ฐ ๊ธธ๊ณ ํฌ๊ด์ ์ธ ๊ฒ๋ณด๋ค ๋ซ์ต๋๋ค.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Step 1: ํ๋ก์ ํธ ํ์ โ ์๋ ์์ง
|
|
30
|
+
|
|
31
|
+
CLAUDE.md๋ฅผ ์์ฑํ๊ธฐ ์ ์ ๋จผ์ ํ๋ก์ ํธ๋ฅผ ํ์ํฉ๋๋ค:
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
Glob: pattern="package.json" โ ์คํ, ์คํฌ๋ฆฝํธ ํ์ธ
|
|
35
|
+
Glob: pattern="*.config.*" โ ๋น๋/๋ฆฐํธ ์ค์
|
|
36
|
+
Glob: pattern="tsconfig.json" โ TypeScript ์ค์
|
|
37
|
+
Glob: pattern=".env.example" โ ํ๊ฒฝ๋ณ์ ๊ตฌ์กฐ
|
|
38
|
+
Glob: pattern="Makefile" โ ๋น๋ ์์คํ
|
|
39
|
+
Glob: pattern="docker-compose.*" โ ์ธํ๋ผ ๊ตฌ์กฐ
|
|
40
|
+
Glob: pattern="CLAUDE.md" โ ๊ธฐ์กด ํ์ผ ํ์ธ
|
|
41
|
+
Glob: pattern="AGENTS.md" โ ํธํ ํ์ผ ํ์ธ
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
์์งํ ์ ๋ณด๋ฅผ ์ฌ์ฉ์์๊ฒ ์์ฝ ์ ์ํ๊ณ , ๋น ์ง ์ปจํ
์คํธ๋ฅผ ์ง๋ฌธํฉ๋๋ค.
|
|
45
|
+
|
|
46
|
+
## Step 2: ์ธํฐ๋ทฐ โ ๋น๋ฐ๊ฒฌ์ ์ ๋ณด ์ถ์ถ
|
|
47
|
+
|
|
48
|
+
์๋ ํ์์ผ๋ก ์ ์ ์๋ ์ ๋ณด๋ง ์ง๋ฌธํฉ๋๋ค. **ํ ๋ฒ์ ์ง๋ฌธ ํ๋, ๊ฐ๋ฅํ๋ฉด ๊ฐ๊ด์**์ผ๋ก:
|
|
49
|
+
|
|
50
|
+
### ์ง๋ฌธ ์นดํ
๊ณ ๋ฆฌ
|
|
51
|
+
|
|
52
|
+
**1. ๋ฐํ์ ํจ์ (Runtime Traps)**
|
|
53
|
+
- ์ฝ๋์์ ๋ณด์ด์ง ์๋ ๋ฐํ์ ์ฐจ์ด๊ฐ ์๋์? (์: Bun vs Node, ESM vs CJS)
|
|
54
|
+
- ํน์ ํ๊ฒฝ์์๋ง ๋ฐ์ํ๋ ๋ฒ๊ทธ๊ฐ ์๋์?
|
|
55
|
+
|
|
56
|
+
**2. ๊ธ์ง ํจํด (Forbidden Patterns)**
|
|
57
|
+
- ์ ๋ ์ฌ์ฉํ๋ฉด ์ ๋๋ ๋ผ์ด๋ธ๋ฌ๋ฆฌ/ํจํด์ด ์๋์?
|
|
58
|
+
- ๊ณผ๊ฑฐ์ ๋ฌธ์ ๋ฅผ ์ผ์ผํจ ์ ๊ทผ๋ฒ์ด ์๋์?
|
|
59
|
+
|
|
60
|
+
**3. ๋นํ์ค ๊ด๋ก (Non-standard Conventions)**
|
|
61
|
+
- ํ์ค๊ณผ ๋ค๋ฅธ ๋ค์ด๋ฐ/๊ตฌ์กฐ ๊ท์น์ด ์๋์?
|
|
62
|
+
- ํ์์ ํฉ์ํ ํน์ํ ์ํฌํ๋ก์ฐ๊ฐ ์๋์?
|
|
63
|
+
|
|
64
|
+
**4. ์ํคํ
์ฒ ๊ฒฐ์ (Architecture Decisions)**
|
|
65
|
+
- ์ฝ๋๋ง ๋ด์๋ ์ ์ ์๋ ์ค๊ณ ์ด์ ๊ฐ ์๋์?
|
|
66
|
+
- ํน์ ํจํด์ ์ ํํ ๋น์ฆ๋์ค ๋งฅ๋ฝ์ด ์๋์?
|
|
67
|
+
|
|
68
|
+
**5. ๊ฒฝ๊ณ์ (Boundaries)**
|
|
69
|
+
- ์์ด์ ํธ๊ฐ ์ ๋ ๊ฑด๋๋ฆฌ๋ฉด ์ ๋๋ ํ์ผ/๋๋ ํ ๋ฆฌ๊ฐ ์๋์?
|
|
70
|
+
- ๋ณ๊ฒฝ ์ ๋ฐ๋์ ํ์ธ๋ฐ์์ผ ํ๋ ์์ญ์ด ์๋์?
|
|
71
|
+
|
|
72
|
+
## Step 3: ๊ตฌ์กฐ ์ค๊ณ โ 3-Layer Architecture
|
|
73
|
+
|
|
74
|
+
์์งํ ์ ๋ณด๋ฅผ 3๊ฐ ๋ ์ด์ด๋ก ๋ถ๋ฆฌํฉ๋๋ค:
|
|
75
|
+
|
|
76
|
+
### Layer 1: CLAUDE.md (ํ๋ก์ ํธ ํ๋ฒ)
|
|
77
|
+
|
|
78
|
+
**๋ชจ๋ ์ธ์
์ ์๋ ๋ก๋** โ ๋ณดํธ์ ์ด๊ณ ์์ ์ ์ธ ์ ๋ณด๋ง.
|
|
79
|
+
|
|
80
|
+
```markdown
|
|
81
|
+
# {ํ๋ก์ ํธ๋ช
}
|
|
82
|
+
|
|
83
|
+
{ํ๋ก์ ํธ๊ฐ ๋ญ์ง 1-2๋ฌธ์ฅ. ์ฝ๋์์ ๋ชฉ์ ์ด ๋ถ๋ถ๋ช
ํ ๋๋ง.}
|
|
84
|
+
|
|
85
|
+
## Tech Stack
|
|
86
|
+
{package.json์์ ๋ฐ๋ก ์ ์ ์๋ ๊ฒ๋ง. ์: "Bun runtime (not Node)"}
|
|
87
|
+
|
|
88
|
+
## Commands
|
|
89
|
+
{package.json scripts์ ์๊ฑฐ๋ ๋น์ง๊ด์ ์ธ ๊ฒ๋ง}
|
|
90
|
+
- `npm run build && npx vitest run` โ ๋น๋ ํ ํ
์คํธ (์์ ์ค์)
|
|
91
|
+
|
|
92
|
+
## Conventions
|
|
93
|
+
{๋ฆฐํฐ๊ฐ ์ก์ง ๋ชปํ๋ ๊ฒ๋ง}
|
|
94
|
+
- ESM only โ imports need `.js` extension
|
|
95
|
+
- {๋นํ์ค ๋ค์ด๋ฐ ๊ท์น์ด ์๋ค๋ฉด}
|
|
96
|
+
|
|
97
|
+
## Gotchas
|
|
98
|
+
{์์ด์ ํธ๊ฐ ๋ฐ๋ณต์ ์ผ๋ก ์ค์ํ ๊ฒ๋ค}
|
|
99
|
+
- **{ํจ์ ์ ๋ชฉ}.** {๊ตฌ์ฒด์ ์ธ do/don't ์ค๋ช
}
|
|
100
|
+
|
|
101
|
+
## Boundaries
|
|
102
|
+
โ
Always: {ํญ์ ํด์ผ ํ๋ ๊ฒ}
|
|
103
|
+
โ ๏ธ Ask first: {๋จผ์ ํ์ธ๋ฐ์์ผ ํ๋ ๊ฒ}
|
|
104
|
+
๐ซ Never: {์ ๋ ํ๋ฉด ์ ๋๋ ๊ฒ}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Layer 2: SPEC.md (๊ธฐ๋ฅ๋ณ ์ค๊ณ ๋ฌธ์)
|
|
108
|
+
|
|
109
|
+
**ํน์ ๊ธฐ๋ฅ ์์
์์๋ง ๋ก๋** โ what๊ณผ why์ ์ง์ค, how๋ ์์ด์ ํธ์๊ฒ.
|
|
110
|
+
|
|
111
|
+
์ ์ฅ ์์น: `.claude/vibe/specs/YYYY-MM-DD-{์ฃผ์ }.md`
|
|
112
|
+
|
|
113
|
+
```markdown
|
|
114
|
+
# {๊ธฐ๋ฅ๋ช
} SPEC
|
|
115
|
+
|
|
116
|
+
## ๋ชฉ์ (Why)
|
|
117
|
+
## ์๊ตฌ์ฌํญ (What)
|
|
118
|
+
## ์ฑ๊ณต ๊ธฐ์ค (Acceptance Criteria)
|
|
119
|
+
## ๊ธฐ์ ์ ์ ์ฝ (Constraints)
|
|
120
|
+
## ๊ฒฝ๊ณ์ (Out of Scope)
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Layer 3: plan.md (์คํ ๊ณํ)
|
|
124
|
+
|
|
125
|
+
**์ธ์
๋ณ ํ์คํฌ ๋ฆฌ์คํธ** โ 2-5๋ถ ๋จ์, ํ์ผ ๊ฒฝ๋ก ๋ช
์.
|
|
126
|
+
|
|
127
|
+
์ ์ฅ ์์น: `.claude/vibe/specs/{name}-execplan.md`
|
|
128
|
+
|
|
129
|
+
```markdown
|
|
130
|
+
# Execution Plan
|
|
131
|
+
|
|
132
|
+
## Task 1: {์ ๋ชฉ}
|
|
133
|
+
- Files: `src/foo.ts`, `src/foo.test.ts`
|
|
134
|
+
- Action: {๊ตฌ์ฒด์ ๋ณ๊ฒฝ ๋ด์ฉ}
|
|
135
|
+
- Verify: `npm test src/foo.test.ts`
|
|
136
|
+
|
|
137
|
+
## Task 2: ...
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## Step 4: ์์ฑ โ ์ฆ๊ฑฐ ๊ธฐ๋ฐ ์์น ์ ์ฉ
|
|
141
|
+
|
|
142
|
+
### ํฌ๊ธฐ ์ ํ
|
|
143
|
+
|
|
144
|
+
| ๋ฑ๊ธ | ์ค ์ | ์ ํฉํ ๊ฒฝ์ฐ |
|
|
145
|
+
|------|-------|------------|
|
|
146
|
+
| ์ต์ | 60-150์ค | ๋๋ถ๋ถ์ ํ๋ก์ ํธ |
|
|
147
|
+
| ํ์ฉ | 150-200์ค | ๋ณต์กํ ๋ชจ๋
ธ๋ ํฌ |
|
|
148
|
+
| ๊ฒฝ๊ณ | 200-300์ค | ๋ถ๋ฆฌ ํ์ |
|
|
149
|
+
| ์ํ | 300์ค+ | ์์ด์ ํธ๊ฐ ์ ๋ฐ ๋ฌด์ |
|
|
150
|
+
|
|
151
|
+
### ์์น๋ณ ์ฃผ์๋ ฅ ๋ถํฌ (Lost in the Middle ํจ๊ณผ)
|
|
152
|
+
|
|
153
|
+
LLM์ ๋ฌธ์์ **์ฒ์๊ณผ ๋**์ ์ง์คํ๊ณ **์ค๊ฐ์ ๋ฌด์**ํฉ๋๋ค:
|
|
154
|
+
|
|
155
|
+
```
|
|
156
|
+
์ฃผ์๋ ฅ: โโโโโโโโโโโโโโโโโโโโโโโโ
|
|
157
|
+
^์์ ^์ค๊ฐ(โ20-40%) ^๋
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
**๋์**:
|
|
161
|
+
- **๊ฐ์ฅ ์ค์ํ ๊ท์น** โ ๋ฌธ์ ์๋จ์ ๋ฐฐ์น
|
|
162
|
+
- **์์ฃผ ์๋ฐ๋๋ ๊ท์น** โ ๋ฌธ์ ํ๋จ(๋)์ ๋ฐฐ์น
|
|
163
|
+
- **๋ฐฐ๊ฒฝ ์ ๋ณด** โ ์ค๊ฐ์ ๋ฐฐ์น (๋ฌด์๋์ด๋ ๊ด์ฐฎ์ ๊ฒ)
|
|
164
|
+
|
|
165
|
+
### ํฌํจ vs ์ ์ธ ์ฒดํฌ๋ฆฌ์คํธ
|
|
166
|
+
|
|
167
|
+
**โ
ํฌํจ (๋น๋ฐ๊ฒฌ์ , ์ด์์ ์ค์)**
|
|
168
|
+
|
|
169
|
+
| ์ ํ | ์์ |
|
|
170
|
+
|------|------|
|
|
171
|
+
| ๋ฐํ์ ํจ์ | "Bun runtime, not Node" |
|
|
172
|
+
| ๊ธ์ง ํจํด | "Never use `any`, use `unknown` + type guards" |
|
|
173
|
+
| SSOT ์์น | "Only edit `constants.ts` for stack mapping" |
|
|
174
|
+
| ์์ ๋ถ๋ณ ๊ท์น | "Build before test, always" |
|
|
175
|
+
| ๋นํ์ค ์ปค๋งจ๋ | ๋ณตํฉ ๋ช
๋ น์ด, ํน์ ํ๋๊ทธ |
|
|
176
|
+
| ๋ณด์ ๊ท์น | ์ธ์ฆ, ๊ฒฝ๋ก ์ํ ๋ฐฉ์ง ๋ฑ |
|
|
177
|
+
|
|
178
|
+
**โ ์ ์ธ (๋ฐ๊ฒฌ ๊ฐ๋ฅํ๊ฑฐ๋ ๋ค๋ฅธ ๋๊ตฌ์ ๋งก๊ธธ ๊ฒ)**
|
|
179
|
+
|
|
180
|
+
| ์ ํ | ์ด์ | ๋์ |
|
|
181
|
+
|------|------|------|
|
|
182
|
+
| ๋๋ ํ ๋ฆฌ ๊ตฌ์กฐ | `ls`๋ก ๋ฐ๊ฒฌ ๊ฐ๋ฅ | ์ฝ๋ ์์ฒด |
|
|
183
|
+
| ๊ธฐ์ ์คํ ๋ชฉ๋ก | `package.json`์ ์์ | ์ฝ๋ ์์ฒด |
|
|
184
|
+
| ์ฝ๋ ์คํ์ผ (๋ค์ฌ์ฐ๊ธฐ, ์ธ๋ฏธ์ฝ๋ก ) | ๋ฆฐํฐ๊ฐ ์ก์ | ESLint, Prettier |
|
|
185
|
+
| API ๋ฌธ์ | ์ฝ๋์์ ์ฝ์ ์ ์์ | Swagger, JSDoc |
|
|
186
|
+
| ์ผ๋ฐ์ Best Practice | LLM์ด ์ด๋ฏธ ์ | ๋ถํ์ |
|
|
187
|
+
| API ํค, ์ํฌ๋ฆฟ | ๋น ๋ฅด๊ฒ ๊ตฌ์์ด ๋จ | `.env`, vault |
|
|
188
|
+
| ๊ธฐ๋ฅ๋ณ ์์ธ ์ง์ | Layer 2๋ก ๋ถ๋ฆฌ | SPEC.md |
|
|
189
|
+
|
|
190
|
+
### ๊ฐ์กฐ ๊ธฐ๋ฒ
|
|
191
|
+
|
|
192
|
+
์ค์ํ ๊ท์น์ด ๋ฌด์๋ ๋ ์ฌ์ฉ:
|
|
193
|
+
|
|
194
|
+
```markdown
|
|
195
|
+
**IMPORTANT**: {critical rule}
|
|
196
|
+
**MUST**: {mandatory action}
|
|
197
|
+
**NEVER**: {absolute prohibition}
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
๋จ, ๋ชจ๋ ์ค์ ๊ฐ์กฐ๋ฅผ ๋ฃ์ผ๋ฉด **๊ฐ์กฐ๊ฐ ๋ฌดํจํ**๋ฉ๋๋ค. P1 ๊ท์น์๋ง ์ฌ์ฉํ์ธ์.
|
|
201
|
+
|
|
202
|
+
### Progressive Disclosure (์ ์ง์ ๊ณต๊ฐ)
|
|
203
|
+
|
|
204
|
+
CLAUDE.md์ ๋ชจ๋ ๊ฒ์ ๋ฃ์ง ๋ง๊ณ ์ฐธ์กฐํ์ธ์:
|
|
205
|
+
|
|
206
|
+
```markdown
|
|
207
|
+
# Architecture
|
|
208
|
+
See @docs/ARCHITECTURE.md for design decisions.
|
|
209
|
+
|
|
210
|
+
# Security
|
|
211
|
+
@.claude/rules/security.md
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
Claude Code๋ `@` ์ฐธ์กฐ๋ฅผ ๋ฐ๋ผ๊ฐ์ ํ์ํ ๋๋ง ๋ก๋ํฉ๋๋ค.
|
|
215
|
+
|
|
216
|
+
## Step 5: ๊ฒ์ฆ โ ์์ฑ ํ์ง ์ฒดํฌ
|
|
217
|
+
|
|
218
|
+
์์ฑ๋ CLAUDE.md๋ฅผ ๊ฒ์ฆํฉ๋๋ค:
|
|
219
|
+
|
|
220
|
+
### ์ค๋ณ ๊ฒ์ฆ
|
|
221
|
+
|
|
222
|
+
๋ชจ๋ ์ค์ ๋ํด 4๊ฐ์ง ์ง๋ฌธ:
|
|
223
|
+
|
|
224
|
+
1. **์ด๊ฑธ ๋นผ๋ฉด ์์ด์ ํธ๊ฐ ์ค์ํ ๊น?** โ No๋ฉด ์ญ์
|
|
225
|
+
2. **๋ชจ๋ ์ธ์
์ ํ์ํ๊ฐ?** โ No๋ฉด Layer 2/3์ผ๋ก ์ด๋
|
|
226
|
+
3. **๋ฆฐํฐ/ํ
์ด ๋์ ํ ์ ์๋?** โ Yes๋ฉด ๋ฆฐํฐ/ํ
์ผ๋ก ์ด๋
|
|
227
|
+
4. **์ฝ๋์์ ๋ฐ๊ฒฌ ๊ฐ๋ฅํ๊ฐ?** โ Yes๋ฉด ์ญ์
|
|
228
|
+
|
|
229
|
+
### ์ต์ปค๋ง ๊ฒฝ๊ณ
|
|
230
|
+
|
|
231
|
+
๊ธฐ์ ๋ช
์ ์ธ๊ธํ๋ฉด ์์ด์ ํธ๊ฐ ๊ทธ์ชฝ์ผ๋ก ํธํฅ๋ฉ๋๋ค:
|
|
232
|
+
- โ "We use React" โ ๋ถํ์ (package.json์ ์์)
|
|
233
|
+
- โ
"Never use jQuery, even for legacy code" โ ์ ์ฉ (ํจ์ ๋ฐฉ์ง)
|
|
234
|
+
|
|
235
|
+
### ํ ํฐ ํจ์จ์ฑ
|
|
236
|
+
|
|
237
|
+
| ๋ฌธ์ | ์์ | ๊ฐ์ |
|
|
238
|
+
|------|------|------|
|
|
239
|
+
| ์ฅํฉํ ์ค๋ช
| "Please always make sure to..." | "Always:" |
|
|
240
|
+
| ์ค๋ณต | ๊ฐ์ ๊ท์น์ ๋ค๋ฅธ ํํ์ผ๋ก ๋ฐ๋ณต | ํ ๋ฒ๋ง |
|
|
241
|
+
| ๋ถํ์ํ ๋งฅ๋ฝ | "As we discussed..." | ์ญ์ |
|
|
242
|
+
|
|
243
|
+
## Step 6: ์ ์ง๋ณด์ โ ์ด์์๋ ๋ฌธ์
|
|
244
|
+
|
|
245
|
+
### ์ ์ง์ ์ถ๊ฐ ํจํด
|
|
246
|
+
|
|
247
|
+
์ฒ์๋ถํฐ ์๋ฒฝํ๊ฒ ์ฐ์ง ๋ง์ธ์:
|
|
248
|
+
|
|
249
|
+
```
|
|
250
|
+
1. ์ต์ํ์ CLAUDE.md๋ก ์์ (30-50์ค)
|
|
251
|
+
2. ์์ด์ ํธ๊ฐ ์ค์ํ๋ ๊ฑธ ๊ด์ฐฐ
|
|
252
|
+
3. ๋ฐ๋ณต๋๋ ์ค์๋ง ๊ท์น์ผ๋ก ์ถ๊ฐ
|
|
253
|
+
4. 2-3์ฃผ๋ง๋ค ๋ถํ์ํ ์ค ์ ๋ฆฌ
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### Reflection Loop (Addy Osmani ํจํด)
|
|
257
|
+
|
|
258
|
+
```
|
|
259
|
+
์์ด์ ํธ ์์
์๋ฃ
|
|
260
|
+
โ "๋ฌด์์ด ์์๊ณผ ๋ฌ๋๋?" ์๋ฌธ
|
|
261
|
+
โ ๋ฐ๋ณต๋๋ ํจํด ๋ฐ๊ฒฌ ์ CLAUDE.md์ 1์ค ์ถ๊ฐ
|
|
262
|
+
โ ๊ทผ๋ณธ ์์ธ์ด ์ฝ๋ ๊ตฌ์กฐ๋ฉด ์ฝ๋๋ฅผ ๊ณ ์น๊ณ ๊ท์น์ ์ถ๊ฐํ์ง ์์
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### ์ํ ์ ํธ
|
|
266
|
+
|
|
267
|
+
| ์ ํธ | ์๋ฏธ | ๋์ |
|
|
268
|
+
|------|------|------|
|
|
269
|
+
| 300์ค ์ด๊ณผ | ์ ๋ณด ๊ณผ๋ถํ | ๋ถ๋ฆฌ ๋๋ ์ ๋ฆฌ |
|
|
270
|
+
| ๊ฐ์ ์ค์ ๋ฐ๋ณต | ๊ท์น์ด ๋
ธ์ด์ฆ์ ๋ฌปํ | ๊ฐ์กฐ ๋๋ ํตํฉ |
|
|
271
|
+
| ๊ท์น ์ถ๊ฐํด๋ ๋ณํ ์์ | ํ์ผ์ด ๋๋ฌด ๊น | ๊ทผ๋ณธ ์์ธ ์์ |
|
|
272
|
+
| ํ์์ด ๊ท์น ๋ฌด์ | ๋ฐ๊ฒฌ ๊ฐ๋ฅํ ์ ๋ณด | ์ญ์ |
|
|
273
|
+
|
|
274
|
+
---
|
|
275
|
+
|
|
276
|
+
## Quick Reference: ํ๋ก์ ํธ ๊ท๋ชจ๋ณ ๊ฐ์ด๋
|
|
277
|
+
|
|
278
|
+
### ์๊ท๋ชจ (ํ์ผ 10๊ฐ ๋ฏธ๋ง)
|
|
279
|
+
|
|
280
|
+
```markdown
|
|
281
|
+
# {ํ๋ก์ ํธ๋ช
}
|
|
282
|
+
|
|
283
|
+
## Commands
|
|
284
|
+
- `{build}` โ {์ค๋ช
}
|
|
285
|
+
- `{test}` โ {์ค๋ช
}
|
|
286
|
+
|
|
287
|
+
## Gotchas
|
|
288
|
+
- **{ํจ์ 1}.** {์ค๋ช
}
|
|
289
|
+
- **{ํจ์ 2}.** {์ค๋ช
}
|
|
290
|
+
|
|
291
|
+
## Never
|
|
292
|
+
- ๐ซ {๊ธ์ง ์ฌํญ}
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
**๋ชฉํ: 20-30์ค**
|
|
296
|
+
|
|
297
|
+
### ์ค๊ท๋ชจ (ํ์ผ 10-50๊ฐ)
|
|
298
|
+
|
|
299
|
+
์ + Conventions, Boundaries ์น์
์ถ๊ฐ.
|
|
300
|
+
|
|
301
|
+
**๋ชฉํ: 60-150์ค**
|
|
302
|
+
|
|
303
|
+
### ๋๊ท๋ชจ (ํ์ผ 50๊ฐ+, ๋ชจ๋
ธ๋ ํฌ)
|
|
304
|
+
|
|
305
|
+
๋ฃจํธ CLAUDE.md (๊ณตํต ๊ท์น) + ํ์ ๋๋ ํ ๋ฆฌ๋ณ CLAUDE.md.
|
|
306
|
+
|
|
307
|
+
```
|
|
308
|
+
project/
|
|
309
|
+
โโโ CLAUDE.md โ ๊ณตํต (60์ค)
|
|
310
|
+
โโโ packages/api/CLAUDE.md โ API ์ ์ฉ (30์ค)
|
|
311
|
+
โโโ packages/web/CLAUDE.md โ ์น ์ ์ฉ (30์ค)
|
|
312
|
+
โโโ .claude/rules/ โ ๊ฒฝ๋ก๋ณ ๊ท์น
|
|
313
|
+
โโโ security.md
|
|
314
|
+
โโโ testing.md
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
**๋ชฉํ: ๋ฃจํธ 100์ค + ํ์ ๊ฐ 30์ค**
|
|
318
|
+
|
|
319
|
+
---
|
|
320
|
+
|
|
321
|
+
## ์ธ์
๋ถ๋ฆฌ ์์น
|
|
322
|
+
|
|
323
|
+
CLAUDE.md ์์ฑ๋ ์ธ์
์ ๋ถ๋ฆฌํ๋ฉด ํ์ง์ด ์ฌ๋ผ๊ฐ๋๋ค:
|
|
324
|
+
|
|
325
|
+
| ์ธ์
| ๋ชฉํ | ์ฐ์ถ๋ฌผ |
|
|
326
|
+
|------|------|--------|
|
|
327
|
+
| ์ธ์
1 | ํ๋ก์ ํธ ํ์ + ์ธํฐ๋ทฐ | ์ด์ |
|
|
328
|
+
| ์ธ์
2 | ๊ฒ์ฆ + ์ต์ ํ | ์ต์ข
๋ณธ |
|
|
329
|
+
| ์ดํ | ์ ์ง์ ์ ์ง๋ณด์ | ์ง์ ๊ฐ์ |
|
|
330
|
+
|
|
331
|
+
์์ฑ ์๋ฃ ํ: `โ /agents-md` ์คํฌ๋ก ์ต์ ํ ๊ฒ์ฆ์ ์คํํ์ธ์.
|
|
332
|
+
|
|
333
|
+
---
|
|
334
|
+
|
|
335
|
+
## References
|
|
336
|
+
|
|
337
|
+
### Research
|
|
338
|
+
- [Curse of Instructions: LLMs Cannot Follow Multiple Instructions at Once](https://openreview.net/forum?id=R6q67CDBCH)
|
|
339
|
+
- [Lost in the Middle: How Language Models Use Long Contexts](https://arxiv.org/abs/2307.03172)
|
|
340
|
+
- [The Instruction Hierarchy: Training LLMs to Prioritize Privileged Instructions](https://arxiv.org/html/2404.13208v1)
|
|
341
|
+
- [Context Length Alone Hurts LLM Performance Despite Perfect Retrieval](https://arxiv.org/html/2510.05381v1)
|
|
342
|
+
|
|
343
|
+
### Official Docs
|
|
344
|
+
- [Claude Code Best Practices](https://code.claude.com/docs/en/best-practices)
|
|
345
|
+
- [Using CLAUDE.md Files](https://claude.com/blog/using-claude-md-files)
|
|
346
|
+
|
|
347
|
+
### Community
|
|
348
|
+
- [Addy Osmani: AGENTS.md](https://addyosmani.com/blog/agents-md/)
|
|
349
|
+
- [HumanLayer: Writing a good CLAUDE.md](https://www.humanlayer.dev/blog/writing-a-good-claude-md)
|
|
350
|
+
- [Builder.io: CLAUDE.md Guide](https://www.builder.io/blog/claude-md-guide)
|
|
351
|
+
- [GitHub Blog: How to Write a Great agents.md](https://github.blog/ai-and-ml/github-copilot/how-to-write-a-great-agents-md-lessons-from-over-2500-repositories/)
|