moai-adk 0.4.5__py3-none-any.whl → 0.20.1__py3-none-any.whl

moai_adk/templates/.claude/skills/moai-cc-skill-factory/templates/SKILL_TEMPLATE.md

@@ -0,0 +1,245 @@
+---
+name: "[Action Verb] [Domain]"
+description: "[Capability 1], [Capability 2], or [Capability 3]. Use when [trigger 1], [trigger 2], or [trigger 3]."
+allowed-tools: "Tool1, Tool2, Tool3"
+---
+
+# [Skill Name]
+
+> **Quick Reference**: See [reference.md](reference.md) for detailed reference, [examples.md](examples.md) for real-world scenarios.
+
+---
+
+## What Is This Skill?
+
+[One-sentence summary of what the Skill provides]
+
+---
+
+## Quick Start
+
+[Fastest path to getting started. 5-10 lines maximum]
+
+```
+Code example showing immediate usage
+```
+
+---
+
+## Overview
+
+### Problem Domain
+
+Describe the problem this Skill solves.
+
+### Scope
+
+What's included:
+- Item 1
+- Item 2
+- Item 3
+
+What's NOT included:
+- Out of scope 1
+- Out of scope 2
+
+### Key Concepts
+
+1. **Concept 1**: Brief explanation
+2. **Concept 2**: Brief explanation
+3. **Concept 3**: Brief explanation
+
+---
+
+## Framework: High Freedom (Principles)
+
+> Use for conceptual guidance, decision frameworks, and principles
+
+### Core Principles
+
+1. **Principle 1**
+   - Rationale
+   - When to apply
+
+2. **Principle 2**
+   - Rationale
+   - When to apply
+
+3. **Principle 3**
+   - Rationale
+   - When to apply
+
+### Decision Framework
+
+```
+Question 1: [Ask]
+├─ If YES: [Recommendation 1]
+└─ If NO: [Recommendation 2]
+
+Question 2: [Ask]
+├─ If YES: [Recommendation 1]
+└─ If NO: [Recommendation 2]
+```
+
+### Trade-off Analysis
+
+| Option | Pros | Cons | When to Use |
+|--------|------|------|-------------|
+| Approach 1 | Pro 1 | Con 1 | Scenario 1 |
+| Approach 2 | Pro 2 | Con 2 | Scenario 2 |
+| Approach 3 | Pro 3 | Con 3 | Scenario 3 |
+
+---
+
+## Framework: Medium Freedom (Patterns)
+
+> Use for standard patterns, workflows, and pseudocode
+
+### Pattern 1: [Pattern Name]
+
+**When to use**: [Describe scenario]
+
+```pseudocode
+1. Step 1
+   ├─ Substep 1
+   └─ Substep 2
+
+2. Step 2
+   ├─ Substep 1
+   └─ Substep 2
+
+3. Step 3
+```
+
+**Example**:
+```python
+# Concrete implementation example
+code_example_here()
+```
+
+### Pattern 2: [Pattern Name]
+
+**When to use**: [Describe scenario]
+
+```pseudocode
+Flowchart or pseudocode here
+```
+
+**Example**:
+```python
+# Concrete implementation example
+code_example_here()
+```
+
+---
+
+## Framework: Low Freedom (Scripts)
+
+> Use for deterministic, error-prone operations
+
+### Script 1: [Script Purpose]
+
+See `scripts/script-name.sh` for the complete implementation.
+
+```bash
+#!/bin/bash
+set -euo pipefail
+
+# This script does [what]
+
+# Step 1: Validate inputs
+if [[ -z "$VAR" ]]; then
+  echo "ERROR: Variable required" >&2
+  exit 1
+fi
+
+# Step 2: Execute operation
+operation_here
+
+# Step 3: Report success
+echo "✓ Operation completed successfully"
+exit 0
+```
+
+**Usage**:
+```bash
+./scripts/script-name.sh [args]
+```
+
+---
+
+## Common Use Cases
+
+### Use Case 1: [Scenario]
+
+Description of the scenario.
+
+**Recommended approach**: [Pattern/Principle reference]
+
+**Example**: See [examples.md](examples.md) Example 1
+
+### Use Case 2: [Scenario]
+
+Description of the scenario.
+
+**Recommended approach**: [Pattern/Principle reference]
+
+**Example**: See [examples.md](examples.md) Example 2
+
+---
+
+## Best Practices
+
+1. **Practice 1**: Recommendation with rationale
+2. **Practice 2**: Recommendation with rationale
+3. **Practice 3**: Recommendation with rationale
+
+---
+
+## Anti-Patterns to Avoid
+
+❌ **Don't do this**: Explanation of what not to do and why
+
+✅ **Do this instead**: Correct approach
+
+---
+
+## FAQ
+
+### Q: [Frequently asked question 1]
+
+A: [Answer with reference to relevant section]
+
+### Q: [Frequently asked question 2]
+
+A: [Answer with reference to relevant section]
+
+### Q: [Frequently asked question 3]
+
+A: [Answer with reference to relevant section]
+
+---
+
+## Related Resources
+
+- [reference.md](reference.md) — Detailed reference documentation
+- [examples.md](examples.md) — Real-world usage examples
+- `scripts/` — Automation utilities
+- `templates/` — Reusable templates
+
+---
+
+## Glossary
+
+- **Term 1**: Definition
+- **Term 2**: Definition
+- **Term 3**: Definition
+
+---
+
+## Version & Status
+
+**Version**: 0.1.0
+**Status**: Draft
+**Last Updated**: 2025-10-22
+**Framework**: MoAI-ADK + Claude Code Skills

moai_adk/templates/.claude/skills/moai-cc-skill-factory/templates/examples-template.md

@@ -0,0 +1,285 @@
+# Examples: [Skill Domain]
+
+Real-world examples demonstrating [Skill Name] in practice.
+
+---
+
+## Example 1: Basic Usage
+
+**Scenario**: [Describe a simple, common scenario]
+
+[Additional context or problem statement]
+
+**Code**:
+```python
+# Basic implementation
+code_example_here()
+```
+
+**Expected Output**:
+```
+expected output or result
+```
+
+**Explanation**:
+- What the code does
+- Why this approach works
+- Key concepts demonstrated
+
+**Related Concept**: See [SKILL.md](SKILL.md) section "[Related Section]"
+
+---
+
+## Example 2: Intermediate Pattern
+
+**Scenario**: [Describe a more complex scenario]
+
+[Context about when this pattern is useful]
+
+**Code**:
+```python
+# Intermediate implementation with error handling
+code_example_with_patterns()
+```
+
+**Expected Output**:
+```
+expected output here
+```
+
+**Key Points**:
+- Pattern 1 from main Skill
+- Pattern 2 from main Skill
+- Error handling strategy
+
+**Variations**:
+- How to modify for similar use case 1
+- How to modify for similar use case 2
+
+**Related Concept**: See [SKILL.md](SKILL.md) section "[Related Section]"
+
+---
+
+## Example 3: Advanced Use Case
+
+**Scenario**: [Describe a complex, less common scenario]
+
+[Problem statement and why this is challenging]
+
+**Code**:
+```python
+# Advanced implementation combining multiple patterns
+advanced_implementation()
+```
+
+**Expected Output**:
+```
+expected output or results
+```
+
+**Why This Works**:
+- How principles from [SKILL.md](SKILL.md) apply
+- Why this approach is optimal for this scenario
+- Performance considerations
+
+**Edge Cases Handled**:
+- Edge case 1 and how it's handled
+- Edge case 2 and how it's handled
+- Edge case 3 and how it's handled
+
+**Performance**:
+- Time complexity: O(...)
+- Space complexity: O(...)
+- Optimization techniques used
+
+**Related Concept**: See [SKILL.md](SKILL.md) section "[Related Section]"
+
+---
+
+## Example 4: Edge Case / Error Handling
+
+**Scenario**: [Describe an unusual or error scenario]
+
+[Why this edge case matters]
+
+**Problem Code** (What NOT to do):
+```python
+# This approach fails in certain conditions
+bad_approach()
+# ❌ Problem: [What goes wrong]
+```
+
+**Solution Code**:
+```python
+# Proper error handling
+correct_approach()
+# ✅ Why this works: [Explanation]
+```
+
+**Input**:
+```
+test_input_here
+```
+
+**Output**:
+```
+expected_output_here
+```
+
+**Key Takeaway**: [Learning point from this example]
+
+**Related Concept**: See [SKILL.md](SKILL.md) section "[Anti-patterns]"
+
+---
+
+## Common Patterns Demonstrated
+
+### Pattern 1: [Pattern Name]
+
+Used in: Example 1, Example 2
+
+Description: [Explain what this pattern accomplishes]
+
+Quick reference:
+```
+Pattern pseudocode or key steps
+```
+
+### Pattern 2: [Pattern Name]
+
+Used in: Example 2, Example 3
+
+Description: [Explain what this pattern accomplishes]
+
+Quick reference:
+```
+Pattern pseudocode or key steps
+```
+
+### Pattern 3: [Pattern Name]
+
+Used in: Example 3, Example 4
+
+Description: [Explain what this pattern accomplishes]
+
+Quick reference:
+```
+Pattern pseudocode or key steps
+```
+
+---
+
+## Troubleshooting Common Issues
+
+### Issue 1: [Common Problem]
+
+**Symptoms**: [What the user observes]
+
+**Root Cause**: [Why it happens]
+
+**Solution**:
+```python
+# Fixed approach
+solution_code()
+```
+
+**Reference**: See Example [X] for similar scenario
+
+### Issue 2: [Common Problem]
+
+**Symptoms**: [What the user observes]
+
+**Root Cause**: [Why it happens]
+
+**Solution**:
+```python
+# Fixed approach
+solution_code()
+```
+
+**Reference**: See [reference.md](reference.md) for details
+
+---
+
+## Quick Reference by Use Case
+
+| Use Case | Best Example | Pattern | Key Concept |
+|----------|--------------|---------|-------------|
+| Getting started | Example 1 | Basic Pattern | Fundamentals |
+| Production use | Example 2 | Standard Pattern | Best practices |
+| Complex scenario | Example 3 | Advanced Pattern | Optimization |
+| Error handling | Example 4 | Error Pattern | Robustness |
+
+---
+
+## Testing Examples
+
+Each example includes test cases to verify correctness:
+
+### Example 1 Tests
+
+```python
+def test_example_1_basic():
+    result = basic_function()
+    assert result == expected_value
+
+def test_example_1_with_input():
+    result = basic_function("input")
+    assert result == expected_value
+```
+
+### Example 2 Tests
+
+```python
+def test_example_2_intermediate():
+    result = intermediate_function()
+    assert result.valid == True
+
+def test_example_2_error_handling():
+    with pytest.raises(ValueError):
+        intermediate_function(bad_input)
+```
+
+---
+
+## Performance Benchmarks
+
+| Example | Input Size | Time | Memory | Notes |
+|---------|-----------|------|--------|-------|
+| Example 1 | 100 items | 10ms | 1MB | Basic |
+| Example 2 | 1K items | 50ms | 5MB | Optimized |
+| Example 3 | 10K items | 200ms | 20MB | Advanced |
+| Example 4 | Edge case | 5ms | 0.5MB | Error handling |
+
+---
+
+## Next Steps
+
+After reviewing these examples:
+
+1. **Understand the basics**: Start with Example 1
+2. **Learn patterns**: Study Examples 2-3
+3. **Handle edge cases**: Review Example 4
+4. **Reference detailed docs**: See [SKILL.md](SKILL.md) and [reference.md](reference.md)
+5. **Run your own tests**: Modify examples for your use case
+
+---
+
+## Related Resources
+
+- [SKILL.md](SKILL.md) — Main framework and concepts
+- [reference.md](reference.md) — Detailed API and configuration reference
+- `scripts/` — Automated tools and utilities
+- `templates/` — Reusable code templates
+
+---
+
+## Version & Updates
+
+**Version**: 0.1.0
+**Last Updated**: 2025-10-22
+**Framework**: MoAI-ADK + Claude Code Skills
+
+### Example History
+
+- v0.1.0: Initial examples added