Initial commit
This commit is contained in:
66
skills/ask-expert/README.md
Normal file
66
skills/ask-expert/README.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# Ask Expert Skill
|
||||
|
||||
> Creates expert consultation documents with automated code extraction, git diffs, and size tracking
|
||||
|
||||
## Overview
|
||||
|
||||
This skill helps Claude create comprehensive technical consultation documents for external expert review. It automatically activates when you ask Claude to prepare code for expert analysis.
|
||||
|
||||
**For complete plugin documentation, see the [main README](../../README.md).**
|
||||
|
||||
## Quick Reference
|
||||
|
||||
**Example prompts:**
|
||||
```
|
||||
"Create an expert consultation document for our authentication refactor"
|
||||
"Prepare code for expert review about our API design"
|
||||
"I need to ask an expert about our database schema"
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Guides you through structuring consultation documents
|
||||
- Extracts code with size tracking (125KB limit)
|
||||
- Organizes content with markdown sections
|
||||
- Supports full files, line ranges, and git diffs
|
||||
|
||||
**Allowed tools:** Bash, Read, Write, Edit
|
||||
|
||||
## Script Usage
|
||||
|
||||
The skill uses a bundled extraction script. For manual usage:
|
||||
|
||||
**Basic extraction:**
|
||||
```bash
|
||||
node scripts/extract-code.js \
|
||||
--track-size --output=doc.md \
|
||||
src/file1.ts src/file2.ts
|
||||
```
|
||||
|
||||
**With sections:**
|
||||
```bash
|
||||
node scripts/extract-code.js \
|
||||
--track-size --output=doc.md \
|
||||
--section="What Changed" src/Service.cs:diff \
|
||||
--section="Implementation" src/Service.cs
|
||||
```
|
||||
|
||||
**Git diffs:**
|
||||
```bash
|
||||
node scripts/extract-code.js \
|
||||
src/Service.cs:diff=master..feature-branch
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- **[SKILL.md](SKILL.md)** - Skill definition for Claude
|
||||
- **[EXAMPLES.md](EXAMPLES.md)** - Detailed usage examples with complete workflows
|
||||
- **[Script Reference](scripts/extract-code.js)** - Run with `--help` for all options
|
||||
|
||||
## Requirements
|
||||
|
||||
- Node.js 18+
|
||||
- Git (for diff functionality)
|
||||
|
||||
## License
|
||||
|
||||
MIT - See [LICENSE](../../LICENSE)
|
||||
Reference in New Issue
Block a user