From ca15ab75dcd7e9314236d272c7aa28d5b5f721ad Mon Sep 17 00:00:00 2001 From: Zhongwei Li Date: Sat, 29 Nov 2025 18:50:48 +0800 Subject: [PATCH] Initial commit --- .claude-plugin/plugin.json | 15 +++ README.md | 3 + commands/sow.md | 109 ++++++++++++++++++ plugin.lock.json | 85 ++++++++++++++ skills/skill-adapter/assets/README.md | 7 ++ .../skill-adapter/assets/config-template.json | 32 +++++ skills/skill-adapter/assets/skill-schema.json | 28 +++++ skills/skill-adapter/assets/test-data.json | 27 +++++ skills/skill-adapter/references/README.md | 7 ++ .../references/best-practices.md | 69 +++++++++++ skills/skill-adapter/references/examples.md | 70 +++++++++++ skills/skill-adapter/scripts/README.md | 7 ++ .../skill-adapter/scripts/helper-template.sh | 42 +++++++ skills/skill-adapter/scripts/validation.sh | 32 +++++ 14 files changed, 533 insertions(+) create mode 100644 .claude-plugin/plugin.json create mode 100644 README.md create mode 100644 commands/sow.md create mode 100644 plugin.lock.json create mode 100644 skills/skill-adapter/assets/README.md create mode 100644 skills/skill-adapter/assets/config-template.json create mode 100644 skills/skill-adapter/assets/skill-schema.json create mode 100644 skills/skill-adapter/assets/test-data.json create mode 100644 skills/skill-adapter/references/README.md create mode 100644 skills/skill-adapter/references/best-practices.md create mode 100644 skills/skill-adapter/references/examples.md create mode 100644 skills/skill-adapter/scripts/README.md create mode 100755 skills/skill-adapter/scripts/helper-template.sh create mode 100755 skills/skill-adapter/scripts/validation.sh diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 0000000..3790fdc --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,15 @@ +{ + "name": "sow-generator", + "description": "Generate professional Statements of Work for AI projects", + "version": "1.0.0", + "author": { + "name": "Claude Code Plugin Hub", + "url": "https://github.com/jeremylongshore/claude-code-plugins" + }, + "skills": [ + "./skills" + ], + "commands": [ + "./commands" + ] +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..b805794 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# sow-generator + +Generate professional Statements of Work for AI projects diff --git a/commands/sow.md b/commands/sow.md new file mode 100644 index 0000000..89e23a6 --- /dev/null +++ b/commands/sow.md @@ -0,0 +1,109 @@ +--- +description: Create Statement of Work document +--- + +# SOW Generator + +Generate professional Statements of Work for AI automation projects. + +## SOW Template + +```markdown +# STATEMENT OF WORK + +## Project Information +- **Client:** [Company Name] +- **Project:** [Project Name] +- **Date:** [Date] +- **Valid Until:** [Date + 30 days] +- **Prepared By:** [Your Agency] + +## 1. Project Overview +[Brief description of what will be delivered and why] + +## 2. Scope of Work + +### In Scope +- Deliverable 1: [Description] +- Deliverable 2: [Description] +- Deliverable 3: [Description] + +### Out of Scope +- [What is explicitly not included] +- [Future phase items] + +## 3. Deliverables +| Deliverable | Description | Completion Date | +|-------------|-------------|-----------------| +| Discovery & Planning | Detailed requirements document | Week 2 | +| Design & Architecture | Technical design document | Week 4 | +| Development | Working automation system | Week 8 | +| Testing & QA | Test reports and bug fixes | Week 10 | +| Deployment | Live system with documentation | Week 12 | +| Training | User training sessions | Week 13 | + +## 4. Timeline +- **Start Date:** [Date] +- **End Date:** [Date] +- **Total Duration:** [X] weeks +- **Key Milestones:** + - Milestone 1: [Date] + - Milestone 2: [Date] + - Milestone 3: [Date] + +## 5. Investment +| Item | Cost | +|------|------| +| Discovery & Planning | $X,XXX | +| Development | $XX,XXX | +| Testing & QA | $X,XXX | +| Training | $X,XXX | +| **Total Project Cost** | **$XX,XXX** | + +**Payment Terms:** +- 30% upon signing ($X,XXX) +- 40% at development completion ($X,XXX) +- 30% upon final delivery ($X,XXX) + +## 6. Client Responsibilities +- Provide access to systems and APIs +- Timely feedback on deliverables +- Designate project stakeholder +- Provide test environment +- User acceptance testing + +## 7. Assumptions +- Client has necessary API access +- Required systems have documented APIs +- Test environment will be provided +- Stakeholders available for meetings +- Timely approval of deliverables + +## 8. Terms & Conditions +- Changes to scope require written approval +- Additional work billed at $XXX/hour +- Payment terms: Net 15 days +- IP ownership transfers upon final payment +- 30-day warranty on deliverables + +## 9. Acceptance Criteria +Project will be considered complete when: +- All deliverables meet specifications +- User acceptance testing passed +- Documentation delivered +- Training completed +- Client signs acceptance form + +## Signatures +**Client Approval:** +Name: ___________________ +Title: ___________________ +Date: ___________________ + +**Agency Authorization:** +Name: ___________________ +Title: ___________________ +Date: ___________________ +``` + +Generate professional SOWs customized for each project type. diff --git a/plugin.lock.json b/plugin.lock.json new file mode 100644 index 0000000..3e1eea5 --- /dev/null +++ b/plugin.lock.json @@ -0,0 +1,85 @@ +{ + "$schema": "internal://schemas/plugin.lock.v1.json", + "pluginId": "gh:jeremylongshore/claude-code-plugins-plus:plugins/ai-agency/sow-generator", + "normalized": { + "repo": null, + "ref": "refs/tags/v20251128.0", + "commit": "f634ce5790766ae2efd22601d7c79b49e7b51aa1", + "treeHash": "9b348c960f358f1e820a0fb3a27bdb4753b952d3062857c9b5b9f7659a97e7c4", + "generatedAt": "2025-11-28T10:18:46.696106Z", + "toolVersion": "publish_plugins.py@0.2.0" + }, + "origin": { + "remote": "git@github.com:zhongweili/42plugin-data.git", + "branch": "master", + "commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390", + "repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data" + }, + "manifest": { + "name": "sow-generator", + "description": "Generate professional Statements of Work for AI projects", + "version": "1.0.0" + }, + "content": { + "files": [ + { + "path": "README.md", + "sha256": "3c29d6f278f79cd9bd774f8822f7a3cf71d047b1c42cde529c515474737b90d8" + }, + { + "path": ".claude-plugin/plugin.json", + "sha256": "bc1c70f7ce9509ae94d6133c09e514227a0e867e680257f490e2e7be7b4004a1" + }, + { + "path": "commands/sow.md", + "sha256": "d45c75656029adef7c89993bef4f97b31061929fb2cad13f88da84de68a8a909" + }, + { + "path": "skills/skill-adapter/references/examples.md", + "sha256": "922bbc3c4ebf38b76f515b5c1998ebde6bf902233e00e2c5a0e9176f975a7572" + }, + { + "path": "skills/skill-adapter/references/best-practices.md", + "sha256": "c8f32b3566252f50daacd346d7045a1060c718ef5cfb07c55a0f2dec5f1fb39e" + }, + { + "path": "skills/skill-adapter/references/README.md", + "sha256": "8c2bfab1439da7b3b1b794c9a818ccb78a86f4be4bfa8c63a3872c58fdd0c6c8" + }, + { + "path": "skills/skill-adapter/scripts/helper-template.sh", + "sha256": "0881d5660a8a7045550d09ae0acc15642c24b70de6f08808120f47f86ccdf077" + }, + { + "path": "skills/skill-adapter/scripts/validation.sh", + "sha256": "92551a29a7f512d2036e4f1fb46c2a3dc6bff0f7dde4a9f699533e446db48502" + }, + { + "path": "skills/skill-adapter/scripts/README.md", + "sha256": "049f6435d4ec2f6686d1988469692822594203a7ed31e65bf8a175fee6457ff8" + }, + { + "path": "skills/skill-adapter/assets/test-data.json", + "sha256": "ac17dca3d6e253a5f39f2a2f1b388e5146043756b05d9ce7ac53a0042eee139d" + }, + { + "path": "skills/skill-adapter/assets/README.md", + "sha256": "cf0e0bc9a2c0ae983e9416b4e23c68e6df1aa3b2114f30f2b6c9bafedbe38561" + }, + { + "path": "skills/skill-adapter/assets/skill-schema.json", + "sha256": "f5639ba823a24c9ac4fb21444c0717b7aefde1a4993682897f5bf544f863c2cd" + }, + { + "path": "skills/skill-adapter/assets/config-template.json", + "sha256": "0c2ba33d2d3c5ccb266c0848fc43caa68a2aa6a80ff315d4b378352711f83e1c" + } + ], + "dirSha256": "9b348c960f358f1e820a0fb3a27bdb4753b952d3062857c9b5b9f7659a97e7c4" + }, + "security": { + "scannedAt": null, + "scannerVersion": null, + "flags": [] + } +} \ No newline at end of file diff --git a/skills/skill-adapter/assets/README.md b/skills/skill-adapter/assets/README.md new file mode 100644 index 0000000..e35036f --- /dev/null +++ b/skills/skill-adapter/assets/README.md @@ -0,0 +1,7 @@ +# Assets + +Bundled resources for sow-generator skill + +- [ ] sow_template.docx: A basic SOW template in DOCX format. +- [ ] example_sow.pdf: An example of a completed SOW. +- [ ] section_templates/: Directory containing templates for different SOW sections (e.g., scope, deliverables, timelines). diff --git a/skills/skill-adapter/assets/config-template.json b/skills/skill-adapter/assets/config-template.json new file mode 100644 index 0000000..16f1712 --- /dev/null +++ b/skills/skill-adapter/assets/config-template.json @@ -0,0 +1,32 @@ +{ + "skill": { + "name": "skill-name", + "version": "1.0.0", + "enabled": true, + "settings": { + "verbose": false, + "autoActivate": true, + "toolRestrictions": true + } + }, + "triggers": { + "keywords": [ + "example-trigger-1", + "example-trigger-2" + ], + "patterns": [] + }, + "tools": { + "allowed": [ + "Read", + "Grep", + "Bash" + ], + "restricted": [] + }, + "metadata": { + "author": "Plugin Author", + "category": "general", + "tags": [] + } +} diff --git a/skills/skill-adapter/assets/skill-schema.json b/skills/skill-adapter/assets/skill-schema.json new file mode 100644 index 0000000..8dc154c --- /dev/null +++ b/skills/skill-adapter/assets/skill-schema.json @@ -0,0 +1,28 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "Claude Skill Configuration", + "type": "object", + "required": ["name", "description"], + "properties": { + "name": { + "type": "string", + "pattern": "^[a-z0-9-]+$", + "maxLength": 64, + "description": "Skill identifier (lowercase, hyphens only)" + }, + "description": { + "type": "string", + "maxLength": 1024, + "description": "What the skill does and when to use it" + }, + "allowed-tools": { + "type": "string", + "description": "Comma-separated list of allowed tools" + }, + "version": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$", + "description": "Semantic version (x.y.z)" + } + } +} diff --git a/skills/skill-adapter/assets/test-data.json b/skills/skill-adapter/assets/test-data.json new file mode 100644 index 0000000..f0cd871 --- /dev/null +++ b/skills/skill-adapter/assets/test-data.json @@ -0,0 +1,27 @@ +{ + "testCases": [ + { + "name": "Basic activation test", + "input": "trigger phrase example", + "expected": { + "activated": true, + "toolsUsed": ["Read", "Grep"], + "success": true + } + }, + { + "name": "Complex workflow test", + "input": "multi-step trigger example", + "expected": { + "activated": true, + "steps": 3, + "toolsUsed": ["Read", "Write", "Bash"], + "success": true + } + } + ], + "fixtures": { + "sampleInput": "example data", + "expectedOutput": "processed result" + } +} diff --git a/skills/skill-adapter/references/README.md b/skills/skill-adapter/references/README.md new file mode 100644 index 0000000..49b6271 --- /dev/null +++ b/skills/skill-adapter/references/README.md @@ -0,0 +1,7 @@ +# References + +Bundled resources for sow-generator skill + +- [ ] sow_best_practices.md: A guide to writing effective statements of work. +- [ ] legal_terms_reference.md: A reference document containing standard legal clauses for SOWs. +- [ ] payment_terms_examples.md: Examples of different payment terms that can be used in SOWs. diff --git a/skills/skill-adapter/references/best-practices.md b/skills/skill-adapter/references/best-practices.md new file mode 100644 index 0000000..3505048 --- /dev/null +++ b/skills/skill-adapter/references/best-practices.md @@ -0,0 +1,69 @@ +# Skill Best Practices + +Guidelines for optimal skill usage and development. + +## For Users + +### Activation Best Practices + +1. **Use Clear Trigger Phrases** + - Match phrases from skill description + - Be specific about intent + - Provide necessary context + +2. **Provide Sufficient Context** + - Include relevant file paths + - Specify scope of analysis + - Mention any constraints + +3. **Understand Tool Permissions** + - Check allowed-tools in frontmatter + - Know what the skill can/cannot do + - Request appropriate actions + +### Workflow Optimization + +- Start with simple requests +- Build up to complex workflows +- Verify each step before proceeding +- Use skill consistently for related tasks + +## For Developers + +### Skill Development Guidelines + +1. **Clear Descriptions** + - Include explicit trigger phrases + - Document all capabilities + - Specify limitations + +2. **Proper Tool Permissions** + - Use minimal necessary tools + - Document security implications + - Test with restricted tools + +3. **Comprehensive Documentation** + - Provide usage examples + - Document common pitfalls + - Include troubleshooting guide + +### Maintenance + +- Keep version updated +- Test after tool updates +- Monitor user feedback +- Iterate on descriptions + +## Performance Tips + +- Scope skills to specific domains +- Avoid overlapping trigger phrases +- Keep descriptions under 1024 chars +- Test activation reliability + +## Security Considerations + +- Never include secrets in skill files +- Validate all inputs +- Use read-only tools when possible +- Document security requirements diff --git a/skills/skill-adapter/references/examples.md b/skills/skill-adapter/references/examples.md new file mode 100644 index 0000000..b1d8bd2 --- /dev/null +++ b/skills/skill-adapter/references/examples.md @@ -0,0 +1,70 @@ +# Skill Usage Examples + +This document provides practical examples of how to use this skill effectively. + +## Basic Usage + +### Example 1: Simple Activation + +**User Request:** +``` +[Describe trigger phrase here] +``` + +**Skill Response:** +1. Analyzes the request +2. Performs the required action +3. Returns results + +### Example 2: Complex Workflow + +**User Request:** +``` +[Describe complex scenario] +``` + +**Workflow:** +1. Step 1: Initial analysis +2. Step 2: Data processing +3. Step 3: Result generation +4. Step 4: Validation + +## Advanced Patterns + +### Pattern 1: Chaining Operations + +Combine this skill with other tools: +``` +Step 1: Use this skill for [purpose] +Step 2: Chain with [other tool] +Step 3: Finalize with [action] +``` + +### Pattern 2: Error Handling + +If issues occur: +- Check trigger phrase matches +- Verify context is available +- Review allowed-tools permissions + +## Tips & Best Practices + +- ✅ Be specific with trigger phrases +- ✅ Provide necessary context +- ✅ Check tool permissions match needs +- ❌ Avoid vague requests +- ❌ Don't mix unrelated tasks + +## Common Issues + +**Issue:** Skill doesn't activate +**Solution:** Use exact trigger phrases from description + +**Issue:** Unexpected results +**Solution:** Check input format and context + +## See Also + +- Main SKILL.md for full documentation +- scripts/ for automation helpers +- assets/ for configuration examples diff --git a/skills/skill-adapter/scripts/README.md b/skills/skill-adapter/scripts/README.md new file mode 100644 index 0000000..c6b1abc --- /dev/null +++ b/skills/skill-adapter/scripts/README.md @@ -0,0 +1,7 @@ +# Scripts + +Bundled resources for sow-generator skill + +- [ ] sow_template_generator.py: Generates a basic SOW template with customizable sections. +- [ ] section_adder.py: Adds specific sections to an existing SOW (e.g., payment terms, legal terms). +- [ ] scope_validator.py: Validates the scope of work against a predefined checklist. diff --git a/skills/skill-adapter/scripts/helper-template.sh b/skills/skill-adapter/scripts/helper-template.sh new file mode 100755 index 0000000..c4aae90 --- /dev/null +++ b/skills/skill-adapter/scripts/helper-template.sh @@ -0,0 +1,42 @@ +#!/bin/bash +# Helper script template for skill automation +# Customize this for your skill's specific needs + +set -e + +function show_usage() { + echo "Usage: $0 [options]" + echo "" + echo "Options:" + echo " -h, --help Show this help message" + echo " -v, --verbose Enable verbose output" + echo "" +} + +# Parse arguments +VERBOSE=false + +while [[ $# -gt 0 ]]; do + case $1 in + -h|--help) + show_usage + exit 0 + ;; + -v|--verbose) + VERBOSE=true + shift + ;; + *) + echo "Unknown option: $1" + show_usage + exit 1 + ;; + esac +done + +# Your skill logic here +if [ "$VERBOSE" = true ]; then + echo "Running skill automation..." +fi + +echo "✅ Complete" diff --git a/skills/skill-adapter/scripts/validation.sh b/skills/skill-adapter/scripts/validation.sh new file mode 100755 index 0000000..590af58 --- /dev/null +++ b/skills/skill-adapter/scripts/validation.sh @@ -0,0 +1,32 @@ +#!/bin/bash +# Skill validation helper +# Validates skill activation and functionality + +set -e + +echo "🔍 Validating skill..." + +# Check if SKILL.md exists +if [ ! -f "../SKILL.md" ]; then + echo "❌ Error: SKILL.md not found" + exit 1 +fi + +# Validate frontmatter +if ! grep -q "^---$" "../SKILL.md"; then + echo "❌ Error: No frontmatter found" + exit 1 +fi + +# Check required fields +if ! grep -q "^name:" "../SKILL.md"; then + echo "❌ Error: Missing 'name' field" + exit 1 +fi + +if ! grep -q "^description:" "../SKILL.md"; then + echo "❌ Error: Missing 'description' field" + exit 1 +fi + +echo "✅ Skill validation passed"