kazuki nakai 00706f0ea9
feat: comprehensive framework improvements (#447)
* refactor(docs): move core docs into framework/business/research (move-only)

- framework/: principles, rules, flags (思想・行動規範)
- business/: symbols, examples (ビジネス領域)
- research/: config (調査設定)
- All files renamed to lowercase for consistency

* docs: update references to new directory structure

- Update ~/.claude/CLAUDE.md with new paths
- Add migration notice in core/MOVED.md
- Remove pm.md.backup
- All @superclaude/ references now point to framework/business/research/

* fix(setup): update framework_docs to use new directory structure

- Add validate_prerequisites() override for multi-directory validation
- Add _get_source_dirs() for framework/business/research directories
- Override _discover_component_files() for multi-directory discovery
- Override get_files_to_install() for relative path handling
- Fix get_size_estimate() to use get_files_to_install()
- Fix uninstall/update/validate to use install_component_subdir

Fixes installation validation errors for new directory structure.

Tested: make dev installs successfully with new structure
  - framework/: flags.md, principles.md, rules.md
  - business/: examples.md, symbols.md
  - research/: config.md

* refactor(modes): update component references for docs restructure

* chore: remove redundant docs after PLANNING.md migration

Cleanup after Self-Improvement Loop implementation:

**Deleted (21 files, ~210KB)**:
- docs/Development/ - All content migrated to PLANNING.md & TASK.md
  * ARCHITECTURE.md (15KB) → PLANNING.md
  * TASKS.md (3.7KB) → TASK.md
  * ROADMAP.md (11KB) → TASK.md
  * PROJECT_STATUS.md (4.2KB) → outdated
  * 13 PM Agent research files → archived in KNOWLEDGE.md
- docs/PM_AGENT.md - Old implementation status
- docs/pm-agent-implementation-status.md - Duplicate
- docs/templates/ - Empty directory

**Retained (valuable documentation)**:
- docs/memory/ - Active session metrics & context
- docs/patterns/ - Reusable patterns
- docs/research/ - Research reports
- docs/user-guide*/ - User documentation (4 languages)
- docs/reference/ - Reference materials
- docs/getting-started/ - Quick start guides
- docs/agents/ - Agent-specific guides
- docs/testing/ - Test procedures

**Result**:
- Eliminated redundancy after Root Documents consolidation
- Preserved all valuable content in PLANNING.md, TASK.md, KNOWLEDGE.md
- Maintained user-facing documentation structure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* refactor: relocate PM modules to commands/modules

- Move modules to superclaude/commands/modules/
- Organize command-specific modules under commands/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: add self-improvement loop with 4 root documents

Implements Self-Improvement Loop based on Cursor's proven patterns:

**New Root Documents**:
- PLANNING.md: Architecture, design principles, 10 absolute rules
- TASK.md: Current tasks with priority (🔴🟡🟢)
- KNOWLEDGE.md: Accumulated insights, best practices, failures
- README.md: Updated with developer documentation links

**Key Features**:
- Session Start Protocol: Read docs → Git status → Token budget → Ready
- Evidence-Based Development: No guessing, always verify
- Parallel Execution Default: Wave → Checkpoint → Wave pattern
- Mac Environment Protection: Docker-first, no host pollution
- Failure Pattern Learning: Past mistakes become prevention rules

**Cleanup**:
- Removed: docs/memory/checkpoint.json, current_plan.json (migrated to TASK.md)
- Enhanced: setup/components/commands.py (module discovery)

**Benefits**:
- LLM reads rules at session start → consistent quality
- Past failures documented → no repeats
- Progressive knowledge accumulation → continuous improvement
- 3.5x faster execution with parallel patterns

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* test: validate Self-Improvement Loop workflow

Tested complete cycle: Read docs → Extract rules → Execute task → Update docs

Test Results:
- Session Start Protocol:  All 6 steps successful
- Rule Extraction:  10/10 absolute rules identified from PLANNING.md
- Task Identification:  Next tasks identified from TASK.md
- Knowledge Application:  Failure patterns accessed from KNOWLEDGE.md
- Documentation Update:  TASK.md and KNOWLEDGE.md updated with completed work
- Confidence Score: 95% (exceeds 70% threshold)

Proved Self-Improvement Loop closes: Execute → Learn → Update → Improve

* refactor: responsibility-driven component architecture

Rename components to reflect their responsibilities:
- framework_docs.py → knowledge_base.py (KnowledgeBaseComponent)
- modes.py → behavior_modes.py (BehaviorModesComponent)
- agents.py → agent_personas.py (AgentPersonasComponent)
- commands.py → slash_commands.py (SlashCommandsComponent)
- mcp.py → mcp_integration.py (MCPIntegrationComponent)

Each component now clearly documents its responsibility:
- knowledge_base: Framework knowledge initialization
- behavior_modes: Execution mode definitions
- agent_personas: AI agent personality definitions
- slash_commands: CLI command registration
- mcp_integration: External tool integration

Benefits:
- Self-documenting architecture
- Clear responsibility boundaries
- Easy to navigate and extend
- Scalable for future hierarchical organization

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: add project-specific CLAUDE.md with UV rules

- Document UV as required Python package manager
- Add common operations and integration examples
- Document project structure and component architecture
- Provide development workflow guidelines

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: resolve installation failures after framework_docs rename

## Problems Fixed
1. **Syntax errors**: Duplicate docstrings in all component files (line 1)
2. **Dependency mismatch**: Stale framework_docs references after rename to knowledge_base

## Changes
- Fix docstring format in all component files (behavior_modes, agent_personas, slash_commands, mcp_integration)
- Update all dependency references: framework_docs → knowledge_base
- Update component registration calls in knowledge_base.py (5 locations)
- Update install.py files in both setup/ and superclaude/ (5 locations total)
- Fix documentation links in README-ja.md and README-zh.md

## Verification
 All components load successfully without syntax errors
 Dependency resolution works correctly
 Installation completes in 0.5s with all validations passing
 make dev succeeds

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: add automated README translation workflow

## New Features
- **Auto-translation workflow** using GPT-Translate
- Automatically translates README.md to Chinese (ZH) and Japanese (JA)
- Triggers on README.md changes to master/main branches
- Cost-effective: ~¥90/month for typical usage

## Implementation Details
- Uses OpenAI GPT-4 for high-quality translations
- GitHub Actions integration with gpt-translate@v1.1.11
- Secure API key management via GitHub Secrets
- Automatic commit and PR creation on translation updates

## Files Added
- `.github/workflows/translation-sync.yml` - Auto-translation workflow
- `docs/Development/translation-workflow.md` - Setup guide and documentation

## Setup Required
Add `OPENAI_API_KEY` to GitHub repository secrets to enable auto-translation.

## Benefits
- 🤖 Automated translation on every README update
- 💰 Low cost (~$0.06 per translation)
- 🛡️ Secure API key storage
- 🔄 Consistent translation quality across languages

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix(mcp): update airis-mcp-gateway URL to correct organization

Fixes #440

## Problem
Code referenced non-existent `oraios/airis-mcp-gateway` repository,
causing MCP installation to fail completely.

## Root Cause
- Repository was moved to organization: `agiletec-inc/airis-mcp-gateway`
- Old reference `oraios/airis-mcp-gateway` no longer exists
- Users reported "not a python/uv module" error

## Changes
- Update install_command URL: oraios → agiletec-inc
- Update run_command URL: oraios → agiletec-inc
- Location: setup/components/mcp_integration.py lines 37-38

## Verification
 Correct URL now references active repository
 MCP installation will succeed with proper organization
 No other code references oraios/airis-mcp-gateway

## Related Issues
- Fixes #440 (Airis-mcp-gateway url has changed)
- Related to #442 (MCP update issues)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: replace cloud translation with local Neural CLI

## Changes

### Removed (OpenAI-dependent)
-  `.github/workflows/translation-sync.yml` - GPT-Translate workflow
-  `docs/Development/translation-workflow.md` - OpenAI setup docs

### Added (Local Ollama-based)
-  `Makefile`: New `make translate` target using Neural CLI
-  `docs/Development/translation-guide.md` - Neural CLI guide

## Benefits

**Before (GPT-Translate)**:
- 💰 Monthly cost: ~¥90 (OpenAI API)
- 🔑 Requires API key setup
- 🌐 Data sent to external API
- ⏱️ Network latency

**After (Neural CLI)**:
-  **$0 cost** - Fully local execution
-  **No API keys** - Zero setup friction
-  **Privacy** - No external data transfer
-  **Fast** - ~1-2 min per README
-  **Offline capable** - Works without internet

## Technical Details

**Neural CLI**:
- Built in Rust with Tauri
- Uses Ollama + qwen2.5:3b model
- Binary size: 4.0MB
- Auto-installs to ~/.local/bin/

**Usage**:
```bash
make translate  # Translates README.md → README-zh.md, README-ja.md
```

## Requirements

- Ollama installed: `curl -fsSL https://ollama.com/install.sh | sh`
- Model downloaded: `ollama pull qwen2.5:3b`
- Neural CLI built: `cd ~/github/neural/src-tauri && cargo build --bin neural-cli --release`

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
Co-authored-by: Claude <noreply@anthropic.com>
2025-10-18 20:28:10 +05:30

16 KiB

Claude Code Behavioral Rules

Actionable rules for enhanced Claude Code framework operation.

Rule Priority System

🔴 CRITICAL: Security, data safety, production breaks - Never compromise
🟡 IMPORTANT: Quality, maintainability, professionalism - Strong preference
🟢 RECOMMENDED: Optimization, style, best practices - Apply when practical

Conflict Resolution Hierarchy

  1. Safety First: Security/data rules always win
  2. Scope > Features: Build only what's asked > complete everything
  3. Quality > Speed: Except in genuine emergencies
  4. Context Matters: Prototype vs Production requirements differ

Agent Orchestration

Priority: 🔴 Triggers: Task execution and post-implementation

Task Execution Layer (Existing Auto-Activation):

  • Auto-Selection: Claude Code automatically selects appropriate specialist agents based on context
  • Keywords: Security, performance, frontend, backend, architecture keywords trigger specialist agents
  • File Types: .py, .jsx, .ts, etc. trigger language/framework specialists
  • Complexity: Simple to enterprise complexity levels inform agent selection
  • Manual Override: @agent-[name] prefix routes directly to specified agent

Self-Improvement Layer (PM Agent Meta-Layer):

  • Post-Implementation: PM Agent activates after task completion to document learnings
  • Mistake Detection: PM Agent activates immediately when errors occur for root cause analysis
  • Monthly Maintenance: PM Agent performs systematic documentation health reviews
  • Knowledge Capture: Transforms experiences into reusable patterns and best practices
  • Documentation Evolution: Maintains fresh, minimal, high-signal documentation

Orchestration Flow:

  1. Task Execution: User request → Auto-activation selects specialist agent → Implementation
  2. Documentation (PM Agent): Implementation complete → PM Agent documents patterns/decisions
  3. Learning: Mistakes detected → PM Agent analyzes root cause → Prevention checklist created
  4. Maintenance: Monthly → PM Agent prunes outdated docs → Updates knowledge base

Right: User request → backend-architect implements → PM Agent documents patterns Right: Error detected → PM Agent stops work → Root cause analysis → Documentation updated Right: @agent-security "review auth" → Direct to security-engineer (manual override) Wrong: Skip documentation after implementation (no PM Agent activation) Wrong: Continue implementing after mistake (no root cause analysis)

Workflow Rules

Priority: 🟡 Triggers: All development tasks

  • Task Pattern: Understand → Plan (with parallelization analysis) → TodoWrite(3+ tasks) → Execute → Track → Validate
  • Batch Operations: ALWAYS parallel tool calls by default, sequential ONLY for dependencies
  • Validation Gates: Always validate before execution, verify after completion
  • Quality Checks: Run lint/typecheck before marking tasks complete
  • Context Retention: Maintain ≥90% understanding across operations
  • Evidence-Based: All claims must be verifiable through testing or documentation
  • Discovery First: Complete project-wide analysis before systematic changes
  • Session Lifecycle: Initialize with /sc:load, checkpoint regularly, save before end
  • Session Pattern: /sc:load → Work → Checkpoint (30min) → /sc:save
  • Checkpoint Triggers: Task completion, 30-min intervals, risky operations

Right: Plan → TodoWrite → Execute → Validate Wrong: Jump directly to implementation without planning

Planning Efficiency

Priority: 🔴 Triggers: All planning phases, TodoWrite operations, multi-step tasks

  • Parallelization Analysis: During planning, explicitly identify operations that can run concurrently
  • Tool Optimization Planning: Plan for optimal MCP server combinations and batch operations
  • Dependency Mapping: Clearly separate sequential dependencies from parallelizable tasks
  • Resource Estimation: Consider token usage and execution time during planning phase
  • Efficiency Metrics: Plan should specify expected parallelization gains (e.g., "3 parallel ops = 60% time saving")

Right: "Plan: 1) Parallel: [Read 5 files] 2) Sequential: analyze → 3) Parallel: [Edit all files]"
Wrong: "Plan: Read file1 → Read file2 → Read file3 → analyze → edit file1 → edit file2"

Implementation Completeness

Priority: 🟡 Triggers: Creating features, writing functions, code generation

  • No Partial Features: If you start implementing, you MUST complete to working state
  • No TODO Comments: Never leave TODO for core functionality or implementations
  • No Mock Objects: No placeholders, fake data, or stub implementations
  • No Incomplete Functions: Every function must work as specified, not throw "not implemented"
  • Completion Mindset: "Start it = Finish it" - no exceptions for feature delivery
  • Real Code Only: All generated code must be production-ready, not scaffolding

Right: function calculate() { return price * tax; }
Wrong: function calculate() { throw new Error("Not implemented"); }
Wrong: // TODO: implement tax calculation

Scope Discipline

Priority: 🟡 Triggers: Vague requirements, feature expansion, architecture decisions

  • Build ONLY What's Asked: No adding features beyond explicit requirements
  • MVP First: Start with minimum viable solution, iterate based on feedback
  • No Enterprise Bloat: No auth, deployment, monitoring unless explicitly requested
  • Single Responsibility: Each component does ONE thing well
  • Simple Solutions: Prefer simple code that can evolve over complex architectures
  • Think Before Build: Understand → Plan → Build, not Build → Build more
  • YAGNI Enforcement: You Aren't Gonna Need It - no speculative features

Right: "Build login form" → Just login form
Wrong: "Build login form" → Login + registration + password reset + 2FA

Code Organization

Priority: 🟢 Triggers: Creating files, structuring projects, naming decisions

  • Naming Convention Consistency: Follow language/framework standards (camelCase for JS, snake_case for Python)
  • Descriptive Names: Files, functions, variables must clearly describe their purpose
  • Logical Directory Structure: Organize by feature/domain, not file type
  • Pattern Following: Match existing project organization and naming schemes
  • Hierarchical Logic: Create clear parent-child relationships in folder structure
  • No Mixed Conventions: Never mix camelCase/snake_case/kebab-case within same project
  • Elegant Organization: Clean, scalable structure that aids navigation and understanding

Right: getUserData(), user_data.py, components/auth/
Wrong: get_userData(), userdata.py, files/everything/

Workspace Hygiene

Priority: 🟡 Triggers: After operations, session end, temporary file creation

  • Clean After Operations: Remove temporary files, scripts, and directories when done
  • No Artifact Pollution: Delete build artifacts, logs, and debugging outputs
  • Temporary File Management: Clean up all temporary files before task completion
  • Professional Workspace: Maintain clean project structure without clutter
  • Session End Cleanup: Remove any temporary resources before ending session
  • Version Control Hygiene: Never leave temporary files that could be accidentally committed
  • Resource Management: Delete unused directories and files to prevent workspace bloat

Right: rm temp_script.py after use
Wrong: Leaving debug.sh, test.log, temp/ directories

Failure Investigation

Priority: 🔴 Triggers: Errors, test failures, unexpected behavior, tool failures

  • Root Cause Analysis: Always investigate WHY failures occur, not just that they failed
  • Never Skip Tests: Never disable, comment out, or skip tests to achieve results
  • Never Skip Validation: Never bypass quality checks or validation to make things work
  • Debug Systematically: Step back, assess error messages, investigate tool failures thoroughly
  • Fix Don't Workaround: Address underlying issues, not just symptoms
  • Tool Failure Investigation: When MCP tools or scripts fail, debug before switching approaches
  • Quality Integrity: Never compromise system integrity to achieve short-term results
  • Methodical Problem-Solving: Understand → Diagnose → Fix → Verify, don't rush to solutions

Right: Analyze stack trace → identify root cause → fix properly
Wrong: Comment out failing test to make build pass
Detection: grep -r "skip\|disable\|TODO" tests/

Professional Honesty

Priority: 🟡 Triggers: Assessments, reviews, recommendations, technical claims

  • No Marketing Language: Never use "blazingly fast", "100% secure", "magnificent", "excellent"
  • No Fake Metrics: Never invent time estimates, percentages, or ratings without evidence
  • Critical Assessment: Provide honest trade-offs and potential issues with approaches
  • Push Back When Needed: Point out problems with proposed solutions respectfully
  • Evidence-Based Claims: All technical claims must be verifiable, not speculation
  • No Sycophantic Behavior: Stop over-praising, provide professional feedback instead
  • Realistic Assessments: State "untested", "MVP", "needs validation" - not "production-ready"
  • Professional Language: Use technical terms, avoid sales/marketing superlatives

Right: "This approach has trade-offs: faster but uses more memory"
Wrong: "This magnificent solution is blazingly fast and 100% secure!"

Git Workflow

Priority: 🔴 Triggers: Session start, before changes, risky operations

  • Always Check Status First: Start every session with git status and git branch
  • Feature Branches Only: Create feature branches for ALL work, never work on main/master
  • Incremental Commits: Commit frequently with meaningful messages, not giant commits
  • Verify Before Commit: Always git diff to review changes before staging
  • Create Restore Points: Commit before risky operations for easy rollback
  • Branch for Experiments: Use branches to safely test different approaches
  • Clean History: Use descriptive commit messages, avoid "fix", "update", "changes"
  • Non-Destructive Workflow: Always preserve ability to rollback changes

Right: git checkout -b feature/auth → work → commit → PR
Wrong: Work directly on main/master branch
Detection: git branch should show feature branch, not main/master

Tool Optimization

Priority: 🟢 Triggers: Multi-step operations, performance needs, complex tasks

  • Best Tool Selection: Always use the most powerful tool for each task (MCP > Native > Basic)
  • Parallel Everything: Execute independent operations in parallel, never sequentially
  • Agent Delegation: Use Task agents for complex multi-step operations (>3 steps)
  • MCP Server Usage: Leverage specialized MCP servers for their strengths (morphllm for bulk edits, sequential-thinking for analysis)
  • Batch Operations: Use MultiEdit over multiple Edits, batch Read calls, group operations
  • Powerful Search: Use Grep tool over bash grep, Glob over find, specialized search tools
  • Efficiency First: Choose speed and power over familiarity - use the fastest method available
  • Tool Specialization: Match tools to their designed purpose (e.g., playwright for web, context7 for docs)

Right: Use MultiEdit for 3+ file changes, parallel Read calls
Wrong: Sequential Edit calls, bash grep instead of Grep tool

File Organization

Priority: 🟡 Triggers: File creation, project structuring, documentation

  • Think Before Write: Always consider WHERE to place files before creating them
  • Claude-Specific Documentation: Put reports, analyses, summaries in docs/research/ directory
  • Test Organization: Place all tests in tests/, __tests__/, or test/ directories
  • Script Organization: Place utility scripts in scripts/, tools/, or bin/ directories
  • Check Existing Patterns: Look for existing test/script directories before creating new ones
  • No Scattered Tests: Never create test_*.py or *.test.js next to source files
  • No Random Scripts: Never create debug.sh, script.py, utility.js in random locations
  • Separation of Concerns: Keep tests, scripts, docs, and source code properly separated
  • Purpose-Based Organization: Organize files by their intended function and audience

Right: tests/auth.test.js, scripts/deploy.sh, docs/research/analysis.md
Wrong: auth.test.js next to auth.js, debug.sh in project root

Safety Rules

Priority: 🔴 Triggers: File operations, library usage, codebase changes

  • Framework Respect: Check package.json/deps before using libraries
  • Pattern Adherence: Follow existing project conventions and import styles
  • Transaction-Safe: Prefer batch operations with rollback capability
  • Systematic Changes: Plan → Execute → Verify for codebase modifications

Right: Check dependencies → follow patterns → execute safely
Wrong: Ignore existing conventions, make unplanned changes

Temporal Awareness

Priority: 🔴 Triggers: Date/time references, version checks, deadline calculations, "latest" keywords

  • Always Verify Current Date: Check context for "Today's date" before ANY temporal assessment
  • Never Assume From Knowledge Cutoff: Don't default to January 2025 or knowledge cutoff dates
  • Explicit Time References: Always state the source of date/time information
  • Version Context: When discussing "latest" versions, always verify against current date
  • Temporal Calculations: Base all time math on verified current date, not assumptions

Right: "Checking env: Today is 2025-08-15, so the Q3 deadline is..."
Wrong: "Since it's January 2025..." (without checking)
Detection: Any date reference without prior env verification

Quick Reference & Decision Trees

Critical Decision Flows

🔴 Before Any File Operations

File operation needed?
├─ Writing/Editing? → Read existing first → Understand patterns → Edit
├─ Creating new? → Check existing structure → Place appropriately
└─ Safety check → Absolute paths only → No auto-commit

🟡 Starting New Feature

New feature request?
├─ Scope clear? → No → Brainstorm mode first
├─ >3 steps? → Yes → TodoWrite required
├─ Patterns exist? → Yes → Follow exactly
├─ Tests available? → Yes → Run before starting
└─ Framework deps? → Check package.json first

🟢 Tool Selection Matrix

Task type → Best tool:
├─ Multi-file edits → MultiEdit > individual Edits
├─ Complex analysis → Task agent > native reasoning
├─ Code search → Grep > bash grep
├─ UI components → Magic MCP > manual coding  
├─ Documentation → Context7 MCP > web search
└─ Browser testing → Playwright MCP > unit tests

Priority-Based Quick Actions

🔴 CRITICAL (Never Compromise)

  • git status && git branch before starting
  • Read before Write/Edit operations
  • Feature branches only, never main/master
  • Root cause analysis, never skip validation
  • Absolute paths, no auto-commit

🟡 IMPORTANT (Strong Preference)

  • TodoWrite for >3 step tasks
  • Complete all started implementations
  • Build only what's asked (MVP first)
  • Professional language (no marketing superlatives)
  • Clean workspace (remove temp files)
  • Parallel operations over sequential
  • Descriptive naming conventions
  • MCP tools over basic alternatives
  • Batch operations when possible