diff --git a/cowork/.github/ISSUE_TEMPLATE/bug_report.md b/cowork/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..cd480d0 --- /dev/null +++ b/cowork/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,51 @@ +--- +name: Bug Report +about: Report an issue with Cowork documentation +title: '[BUG] ' +labels: bug +assignees: '' + +--- + +## Description + +A clear and concise description of the bug. + +## Location + +Which file or section has the issue? + +- **File**: (e.g., `guide/02-capabilities.md`) +- **Section**: (e.g., "Excel Capabilities") +- **Line**: (if known) + +## Expected Behavior + +What should the documentation say or do? + +## Actual Behavior + +What does it currently say or do? + +## Steps to Reproduce + +If applicable, how can we verify this issue? + +1. Go to '...' +2. Read section '...' +3. Try prompt '...' +4. See error + +## Environment + +- **Platform**: (e.g., macOS 14.2) +- **Cowork Version**: (from Claude Desktop β†’ Settings β†’ About) +- **Subscription**: Pro / Max + +## Additional Context + +Add any other context, screenshots, or error messages. + +## Suggested Fix + +If you have a suggestion for fixing this, please share it. diff --git a/cowork/.github/ISSUE_TEMPLATE/config.yml b/cowork/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..4f42d06 --- /dev/null +++ b/cowork/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: πŸ’¬ Discussions + url: https://github.com/FlorianBruniaux/claude-code-ultimate-guide/discussions + about: Ask questions, share workflows, or discuss Cowork in general + - name: πŸ“– Documentation + url: https://github.com/FlorianBruniaux/claude-code-ultimate-guide/tree/main/cowork + about: Browse the complete Cowork documentation + - name: πŸ†˜ Cowork Support + url: https://support.anthropic.com/ + about: Get official support for Cowork technical issues diff --git a/cowork/.github/ISSUE_TEMPLATE/feature_request.md b/cowork/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..3910f67 --- /dev/null +++ b/cowork/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,55 @@ +--- +name: Feature Request +about: Suggest a documentation improvement or new content +title: '[FEATURE] ' +labels: enhancement +assignees: '' + +--- + +## Summary + +Brief description of what you'd like to see added or improved. + +## Motivation + +What problem does this solve? What use case does it address? + +## Proposed Solution + +How would you like to see this implemented in the documentation? + +**Type** (check one): +- [ ] New workflow guide +- [ ] New prompts for existing category +- [ ] New prompt category +- [ ] Improve existing documentation +- [ ] New reference material +- [ ] Other (describe below) + +## Example + +If applicable, provide an example of what you're envisioning: + +``` +CONTEXT: [example context] +TASK: [example task] +OUTPUT: [example output] +CONSTRAINTS: [example constraints] +``` + +## Use Case + +Who would benefit from this? How would they use it? + +- **User type**: (e.g., Knowledge Worker, PM, Power User) +- **Frequency**: (e.g., Daily, Weekly, One-time) +- **Impact**: (e.g., High, Medium, Low) + +## Alternatives Considered + +Are there existing workarounds? Why aren't they sufficient? + +## Additional Context + +Add any other context, screenshots, or examples. diff --git a/cowork/.github/ISSUE_TEMPLATE/workflow_contribution.md b/cowork/.github/ISSUE_TEMPLATE/workflow_contribution.md new file mode 100644 index 0000000..8febba3 --- /dev/null +++ b/cowork/.github/ISSUE_TEMPLATE/workflow_contribution.md @@ -0,0 +1,84 @@ +--- +name: Workflow Contribution +about: Share a real-world Cowork workflow +title: '[WORKFLOW] ' +labels: workflow, community +assignees: '' + +--- + +## Workflow Name + +Brief, descriptive name for this workflow. + +## Use Case + +What problem does this workflow solve? + +## Prerequisites + +What's needed before starting this workflow? + +- **Files/Data**: (e.g., "20+ receipt images") +- **Workspace Setup**: (e.g., "~/Cowork-Workspace/receipts/ folder") +- **Estimated Time**: (e.g., "15-20 minutes") +- **Complexity**: Beginner / Intermediate / Advanced + +## Steps + +Provide detailed steps with actual prompts you've used successfully. + +### Step 1: [Step Name] + +**Prompt**: +``` +CONTEXT: [your context] +TASK: [your task] +OUTPUT: [your output specification] +CONSTRAINTS: [your constraints] +``` + +**Expected Result**: [what happens after this step] + +### Step 2: [Step Name] + +[Continue for all steps...] + +## Common Issues + +What problems did you encounter? How did you solve them? + +- **Issue 1**: [Description] + - **Solution**: [How you fixed it] + +## Success Criteria + +How do you know the workflow succeeded? + +- [ ] [Criterion 1] +- [ ] [Criterion 2] + +## Testing + +Have you tested this workflow multiple times? + +- **Times tested**: (e.g., "5+ times successfully") +- **Success rate**: (e.g., "100% with manual OCR correction") +- **Platform**: (e.g., "macOS 14.2, Pro tier") + +## Screenshots / Examples + +If applicable, add screenshots or example outputs (redact sensitive info). + +## Additional Notes + +Any tips, variations, or warnings for others using this workflow? + +--- + +**Checklist before submitting:** +- [ ] I have tested this workflow successfully multiple times +- [ ] All prompts use CTOC format (Contextβ†’Taskβ†’Outputβ†’Constraints) +- [ ] I've included expected results for each step +- [ ] I've documented common issues and solutions +- [ ] I've removed any sensitive or personal information diff --git a/cowork/.github/PULL_REQUEST_TEMPLATE.md b/cowork/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..a970a8e --- /dev/null +++ b/cowork/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,57 @@ +# Pull Request + +## Description + +Brief description of what this PR changes. + +## Type of Change + +- [ ] Bug fix (documentation error, broken link, typo) +- [ ] New content (new prompts, workflow, guide section) +- [ ] Enhancement (improve existing content) +- [ ] Refactor (reorganize without changing meaning) +- [ ] Other (describe): + +## Changes Made + +List the specific files and sections modified: + +- `file/path.md` - Brief description of change +- `file/path.md` - Brief description of change + +## Testing + +How have you verified these changes? + +- [ ] Tested prompts in Cowork (if applicable) +- [ ] Verified all links work +- [ ] Checked formatting renders correctly +- [ ] Followed CTOC format for prompts (if applicable) +- [ ] Followed style guide (see CONTRIBUTING.md) + +**Testing Environment** (if applicable): +- **Platform**: (e.g., macOS 14.2) +- **Cowork Version**: (from Claude Desktop β†’ Settings β†’ About) +- **Subscription**: Pro / Max + +## Checklist + +- [ ] I have read [CONTRIBUTING.md](../CONTRIBUTING.md) +- [ ] My changes follow the documentation style guide +- [ ] I have updated cross-references if needed +- [ ] I have updated the stats if needed (run `./scripts/update-stats.sh`) +- [ ] No broken links +- [ ] Prompts use CTOC format +- [ ] Examples are included where appropriate + +## Related Issues + +Closes #(issue number) or Fixes #(issue number) + +## Screenshots (if applicable) + +Add screenshots to show formatting, new sections, etc. + +## Additional Context + +Any other information relevant to this PR. diff --git a/cowork/.github/README.md b/cowork/.github/README.md new file mode 100644 index 0000000..d1d9a21 --- /dev/null +++ b/cowork/.github/README.md @@ -0,0 +1,90 @@ +# GitHub Templates for Cowork Documentation + +This directory contains templates for issues and pull requests to make contributing easier. + +## Templates Available + +### Issue Templates + +1. **Bug Report** (`ISSUE_TEMPLATE/bug_report.md`) + - For documentation errors, broken links, typos + - Requires: Location, expected vs actual behavior, environment + +2. **Feature Request** (`ISSUE_TEMPLATE/feature_request.md`) + - For suggesting new content or improvements + - Types: New workflow, new prompts, improved docs, etc. + +3. **Workflow Contribution** (`ISSUE_TEMPLATE/workflow_contribution.md`) + - For sharing real-world Cowork workflows + - Requires: Tested multiple times, CTOC format, success criteria + +### Pull Request Template + +**PULL_REQUEST_TEMPLATE.md** +- Standard PR template with checklist +- Covers all contribution types +- Includes testing requirements + +## How to Use + +### Creating an Issue + +1. Go to [Issues](../../issues/new/choose) +2. Select appropriate template +3. Fill in all required sections +4. Submit + +### Creating a Pull Request + +1. Fork the repository +2. Create a branch: `git checkout -b feature/my-contribution` +3. Make your changes +4. Test thoroughly (use scripts in `../scripts/`) +5. Push: `git push origin feature/my-contribution` +6. Open PR - template will auto-populate +7. Complete all checklist items + +## Contribution Guidelines + +See [CONTRIBUTING.md](../CONTRIBUTING.md) for: +- Style guide +- CTOC format for prompts +- Review process +- Testing requirements + +## Scripts for Contributors + +Before submitting a PR, run these scripts: + +```bash +# Check version sync +./scripts/check-version-sync.sh + +# Update statistics (prompts count, workflows count) +./scripts/update-stats.sh + +# View changes +git diff +``` + +## Labels + +When creating issues, maintainers will apply these labels: + +| Label | Purpose | +|-------|---------| +| `bug` | Documentation errors | +| `enhancement` | New features or improvements | +| `workflow` | Workflow contributions | +| `prompt` | Prompt contributions | +| `community` | Community-contributed content | +| `good-first-issue` | Great for new contributors | +| `help-wanted` | Extra attention needed | + +## Future Repository + +**Note**: This `.github/` structure is prepared for when Cowork documentation moves to a dedicated repository (`claude-cowork-guide`). Until then, contributions should go to the [main repository](https://github.com/FlorianBruniaux/claude-code-ultimate-guide) with `[cowork]` prefix in titles. + +--- + +*Questions? Open a [Discussion](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/discussions)* diff --git a/cowork/CHANGELOG.md b/cowork/CHANGELOG.md new file mode 100644 index 0000000..0917512 --- /dev/null +++ b/cowork/CHANGELOG.md @@ -0,0 +1,104 @@ +# Changelog + +All notable changes to the Cowork Documentation will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [1.0.0] - 2026-01-20 + +### Added + +**Core Documentation** (6 guides): +- [00-overview.md](guide/00-overview.md) - What is Cowork, architecture, positioning +- [01-getting-started.md](guide/01-getting-started.md) - Installation, setup, CTOC framework +- [02-capabilities.md](guide/02-capabilities.md) - Detailed feature matrix, limitations +- [03-security.md](guide/03-security.md) - Best practices, risk mitigation +- [04-troubleshooting.md](guide/04-troubleshooting.md) - Error messages, decision tree + +**Workflows** (5 step-by-step guides): +- [file-organization.md](workflows/file-organization.md) - Downloads β†’ structured folders +- [expense-tracking.md](workflows/expense-tracking.md) - Receipts β†’ Excel report +- [report-synthesis.md](workflows/report-synthesis.md) - Multi-doc β†’ structured report +- [meeting-prep.md](workflows/meeting-prep.md) - Research β†’ briefing document +- [team-handoff.md](workflows/team-handoff.md) - Dev ↔ Non-dev patterns + +**Prompts Library** (60+ ready-to-use): +- [file-ops.md](prompts/file-ops.md) - 20 prompts for organization, renaming, cleanup +- [document-creation.md](prompts/document-creation.md) - 15 prompts for reports, Excel, presentations +- [data-extraction.md](prompts/data-extraction.md) - 15 prompts for OCR, receipts, invoices +- [research.md](prompts/research.md) - 17 prompts for web research, synthesis + +**Reference Materials** (4 files): +- [cheatsheet.md](reference/cheatsheet.md) - 1-page printable reference +- [comparison.md](reference/comparison.md) - Cowork vs Copilot/Gemini/ChatGPT/Apple Intelligence +- [faq.md](reference/faq.md) - 20+ frequently asked questions +- [glossary.md](reference/glossary.md) - Cowork-specific terminology + +**Research-Based Improvements**: +- Exact error messages with solutions (VM timeout, Chrome host, context limits) +- Competitive analysis matrix (5 products, 8 dimensions) +- Enterprise validation (TELUS, Rakuten, Zapier stats) +- OCR accuracy benchmarks (97% field, 63% line-item) +- Token budget planning per task type +- VPN incompatibility documentation (#1 community issue) +- Context limit reality (165K vs 200K theoretical) + +**Tools**: +- [cowork-onboarding.md](tools/cowork-onboarding.md) - Interactive personalized onboarding + +**Machine-Readable**: +- [cowork-reference.yaml](../machine-readable/cowork-reference.yaml) - LLM-optimized index (~1.5K tokens) + +**Templates**: +- [CLAUDE.md](examples/CLAUDE.md) - Project context file template for Cowork + +### Documentation Features + +- **Learning Paths**: 3 user profiles (Knowledge Worker, PM/Executive, Power User) +- **Golden Rules**: 7 essential principles for safe Cowork usage +- **Interactive Onboarding**: Personalized learning experience via cowork-onboarding.md +- **Decision Trees**: Visual guides for troubleshooting and use case fit +- **CTOC Framework**: Contextβ†’Taskβ†’Outputβ†’Constraints prompting pattern + +### Technical Details + +- **Platform**: macOS only (Windows planned, no ETA) +- **Subscription**: Pro ($20/mo) or Max ($100-200/mo) +- **Status**: Research preview +- **Files**: 23 markdown files, ~50K words +- **Prompts**: 67 copy-paste ready prompts +- **Workflows**: 5 complete step-by-step guides + +### Known Limitations Documented + +- VPN incompatibility (VM routing conflict) +- Context limit: ~165K effective (not 200K theoretical) +- Usage limits: 5-hour reset cycles +- Pro tier: ~1-1.5h intensive use before exhaustion +- OCR accuracy: 97% fields, 63% line items +- No official security documentation from Anthropic + +### Sources + +Based on: +- Perplexity research (P0: Error Messages, P1: Competitive Analysis, P2: Enterprise Case Studies) +- Community feedback (r/ClaudeAI, Anthropic forums) +- Official Anthropic documentation +- Real-world testing and validation + +--- + +## [Unreleased] + +### Planned + +- Additional workflows (email triage, invoice processing) +- Video tutorials for visual learners +- Community-contributed prompts section +- Advanced CTOC patterns library +- Cowork + MCP integration examples + +--- + +*Note*: This documentation currently lives in the [claude-code-ultimate-guide](https://github.com/FlorianBruniaux/claude-code-ultimate-guide) repository. Future plan is to migrate to a dedicated `claude-cowork-guide` repository when Cowork exits research preview and documentation exceeds 50+ files. diff --git a/cowork/CONTRIBUTING.md b/cowork/CONTRIBUTING.md new file mode 100644 index 0000000..bd7a47e --- /dev/null +++ b/cowork/CONTRIBUTING.md @@ -0,0 +1,242 @@ +# Contributing to Cowork Documentation + +Thank you for your interest in improving the Cowork documentation! This guide will help you contribute effectively. + +--- + +## πŸ“ Current Status + +**Location**: This documentation currently lives in the [claude-code-ultimate-guide](https://github.com/FlorianBruniaux/claude-code-ultimate-guide) repository under the `cowork/` directory. + +**Future**: Migration to dedicated `claude-cowork-guide` repository planned when Cowork exits research preview. + +**For now**: All contributions should be made to the main repository with `[cowork]` prefix in issues/PRs. + +--- + +## 🎯 Ways to Contribute + +### 1. Report Issues + +Found a problem? Open an issue in the [main repository](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/issues). + +**Use `[cowork]` prefix** in the title: +- βœ… `[cowork] VPN workaround instructions unclear` +- βœ… `[cowork] OCR accuracy claim needs source` +- ❌ `File organization doesn't work` (too vague) + +**Include**: +- Platform (macOS version) +- Subscription tier (Pro or Max) +- Cowork version (from Claude Desktop β†’ Settings β†’ About) +- Exact error message (if applicable) +- Steps to reproduce + +### 2. Suggest Improvements + +Have an idea? Open an issue with: +- **Problem**: What's missing or could be better +- **Proposed solution**: Specific improvement +- **Use case**: Why this helps users + +### 3. Submit Workflows + +Share your real-world Cowork workflows: + +**Requirements**: +- **Tested**: You've used this workflow successfully +- **Practical**: Solves a real problem +- **Documented**: Clear steps with example prompts +- **Reproducible**: Others can follow and achieve similar results + +**Template**: +```markdown +# [Workflow Name] + +## Use Case +[What problem this solves] + +## Prerequisites +- [File types needed] +- [Workspace setup] +- [Estimated time] + +## Steps + +### 1. [Step Name] +**Prompt**: +``` +CONTEXT: [situation] +TASK: [what to do] +OUTPUT: [format and location] +CONSTRAINTS: [rules] +``` + +**Expected result**: [what happens] + +[Continue for all steps...] + +## Common Issues +- [Issue 1]: [Solution] +- [Issue 2]: [Solution] + +## Success Criteria +[How to know it worked] +``` + +### 4. Contribute Prompts + +Add prompts to the library: + +**Requirements**: +- **Tested**: Works reliably in Cowork +- **Categorized**: Fits in file-ops/document-creation/data-extraction/research +- **CTOC Format**: Uses Contextβ†’Taskβ†’Outputβ†’Constraints structure +- **Documented**: Includes expected result and common variations + +**Template**: +```markdown +### [Prompt Name] + +**Use case**: [When to use this] + +**Prompt**: +``` +CONTEXT: [situation] +TASK: [what to do] +OUTPUT: [format and location] +CONSTRAINTS: [rules] +``` + +**Expected result**: [what Cowork will produce] + +**Variations**: +- [Variation 1]: [How to adapt] +- [Variation 2]: [How to adapt] + +**Common issues**: +- [Issue]: [Solution] +``` + +### 5. Fix Documentation Errors + +Found a typo, broken link, or outdated information? Submit a PR. + +**Small fixes** (typos, links): Direct PR welcome +**Large changes** (restructure, new sections): Open an issue first to discuss + +### 6. Share Research + +Found useful data about Cowork? Share it! + +**Valuable contributions**: +- Official Anthropic announcements +- Community pain points (Reddit, forums) +- OCR accuracy tests on specific document types +- Token consumption measurements +- Performance benchmarks +- Platform compatibility updates + +**Format**: Open an issue with `[cowork][research]` prefix and include sources. + +--- + +## πŸ“ Style Guide + +### Writing Principles + +1. **Practical over theoretical** - Focus on actionable knowledge +2. **Accuracy over marketing** - No invented stats, cite sources +3. **Specific over vague** - "OCR accuracy ~97% for vendor names" not "OCR is good" +4. **Examples included** - Every concept has a real example +5. **Beginner-friendly** - Knowledge workers, not developers + +### Prompts + +- **Always use CTOC format** (Contextβ†’Taskβ†’Outputβ†’Constraints) +- **Include file paths** in prompts (`~/Cowork-Workspace/input/`) +- **Specify output format** (Excel with formulas, Word with headers, etc.) +- **Add constraints** (currency, separators, regional settings) + +Example: +``` +CONTEXT: I have 15 PDF invoices from different vendors in ~/Cowork-Workspace/input/invoices/ +TASK: Extract invoice data into a structured format +OUTPUT: Save as ~/Cowork-Workspace/output/invoices.xlsx with columns: Date, Vendor, Invoice#, Amount, Status +CONSTRAINTS: Use EUR currency, European Excel formula syntax (semicolons), flag amounts >1000 in red +``` + +### Documentation Structure + +- **Headers**: Sentence case, not Title Case +- **Lists**: Parallel structure, consistent punctuation +- **Code blocks**: Specify language for syntax highlighting +- **Tables**: Use for comparisons, structured data +- **Collapsibles**: For long content that breaks flow + +### Tone + +- **Professional but approachable** - Not academic, not casual +- **Confident but honest** - Admit limitations, cite uncertainties +- **Helpful not patronizing** - Respect reader's intelligence + +--- + +## πŸ” Review Process + +### For Issues + +- **Response time**: ~48 hours for acknowledgment +- **Triage**: `bug`, `enhancement`, `documentation`, `question` +- **Priority**: Based on impact and community feedback + +### For Pull Requests + +**Checklist** (add this to your PR): +```markdown +- [ ] Tested on Cowork (macOS, Pro/Max tier) +- [ ] Follows CTOC format (for prompts) +- [ ] Includes examples +- [ ] Updated relevant cross-references +- [ ] No broken links +- [ ] Follows style guide +``` + +**Review timeline**: +- Small fixes: ~24 hours +- New prompts: ~48 hours +- New workflows: ~1 week (requires testing) +- Major changes: ~2 weeks (requires discussion) + +--- + +## ❓ Questions? + +- **Documentation questions**: Open an issue with `[cowork][question]` +- **Technical support**: Use [Claude Desktop support](https://support.anthropic.com/) +- **General discussion**: Use repository [Discussions](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/discussions) + +--- + +## πŸ“„ License + +By contributing, you agree that your contributions will be licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/). + +**This means**: +- βœ… Free to share and adapt +- βœ… Must give attribution +- βœ… Share-alike (derivatives under same license) +- ❌ No additional restrictions + +--- + +## πŸ™ Recognition + +Contributors are recognized in: +- Repository contributors graph +- CHANGELOG.md (for significant contributions) +- Documentation credits (for major additions) + +--- + +*Thank you for helping make Cowork documentation better for everyone!* diff --git a/cowork/MANIFEST.yaml b/cowork/MANIFEST.yaml index f139b70..c4cf904 100644 --- a/cowork/MANIFEST.yaml +++ b/cowork/MANIFEST.yaml @@ -31,6 +31,12 @@ availability: # Documentation structure structure: + root: + - README.md + - VERSION + - CHANGELOG.md + - CONTRIBUTING.md + - MANIFEST.yaml guide: - 00-overview.md - 01-getting-started.md @@ -55,13 +61,29 @@ structure: - glossary.md examples: - CLAUDE.md + tools: + - cowork-onboarding.md + scripts: + - check-version-sync.sh + - sync-version.sh + - update-stats.sh + github: + - ISSUE_TEMPLATE/bug_report.md + - ISSUE_TEMPLATE/feature_request.md + - ISSUE_TEMPLATE/workflow_contribution.md + - ISSUE_TEMPLATE/config.yml + - PULL_REQUEST_TEMPLATE.md + - README.md # Content metadata metadata: language: en - last_updated: 2026-01-19 + last_updated: 2026-01-20 maintainer: claude-code-ultimate-guide contributors - license: MIT + license: CC-BY-SA-4.0 + total_files: 34 + total_prompts: 67 + total_workflows: 5 # Future standalone repo configuration standalone_config: diff --git a/cowork/README.md b/cowork/README.md index 1e227df..791f7b6 100644 --- a/cowork/README.md +++ b/cowork/README.md @@ -2,9 +2,18 @@ > **Complete guide for Claude's agentic desktop feature for knowledge workers** -[![Status: Research Preview](https://img.shields.io/badge/Status-Research%20Preview-yellow)](https://claude.ai/cowork) -[![Platform: macOS](https://img.shields.io/badge/Platform-macOS-blue)]() -[![Subscription: Pro & Max](https://img.shields.io/badge/Subscription-Pro%20%26%20Max-purple)]() +

+ Stars + Prompts + Workflows +

+ +

+ Status + Platform + Subscription + Version +

--- @@ -30,9 +39,9 @@ Think of it as **Claude Code for everyone**: same agentic capabilities, but thro --- -## Quick Start +## ⚑ Quick Start -### 1. Access Requirements +### Prerequisites | Requirement | Details | |-------------|---------| @@ -40,28 +49,82 @@ Think of it as **Claude Code for everyone**: same agentic capabilities, but thro | **Platform** | macOS only (Windows planned, no ETA) | | **App** | Claude Desktop (latest version) | -### 2. Enable Cowork +### Enable Cowork 1. Open **Claude Desktop** app 2. Go to **Settings** β†’ **Features** 3. Enable **Cowork** toggle 4. Grant folder access when prompted -### 3. Your First Task +### Your First Task + +```bash +# Create workspace +mkdir -p ~/Cowork-Workspace/{input,output} + +# Add sample files to organize +# Then in Claude Desktop: +"Organize the files in ~/Cowork-Workspace/input/ by type" +``` + +
+Interactive Onboarding (personalized learning) + +**Run this in Claude Desktop** for a guided tour adapted to your use case: ``` -Create a folder: ~/Cowork-Workspace/ -Add some files to organize -Prompt: "Organize the files in ~/Cowork-Workspace/ by type" +Follow the Cowork onboarding instructions from: +https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate-guide/main/cowork/tools/cowork-onboarding.md ``` +Cowork will analyze your needs and create a personalized learning path. + +
+ β†’ [Complete Getting Started Guide](guide/01-getting-started.md) --- -## Documentation Map +## 🎯 Learning Paths -### Core Guides +
+Knowledge Worker β€” Foundation path (5 steps) + +1. [Overview](guide/00-overview.md) β€” What is Cowork, architecture +2. [Getting Started](guide/01-getting-started.md) β€” First workflow, CTOC framework +3. [File Organization Workflow](workflows/file-organization.md) β€” Practical example +4. [Prompts Library](prompts/file-ops.md) β€” 15+ ready-to-use prompts +5. [Cheatsheet](reference/cheatsheet.md) β€” Print this + +
+ +
+Product Manager / Executive β€” Overview path (4 steps) + +1. [What's Inside](#-whats-inside) β€” Scope & capabilities +2. [Golden Rules](#-golden-rules) β€” Key principles +3. [Security](guide/03-security.md) β€” Safe usage practices +4. [Comparison](reference/comparison.md) β€” Cowork vs Copilot/Gemini/ChatGPT + +
+ +
+Power User β€” Comprehensive path (6 steps) + +1. [Complete Capabilities](guide/02-capabilities.md) β€” Detailed feature matrix +2. [All Workflows](workflows/) β€” 5 step-by-step guides +3. [Troubleshooting](guide/04-troubleshooting.md) β€” Error resolution +4. [FAQ](reference/faq.md) β€” 20+ questions +5. [Advanced Prompts](prompts/research.md) β€” Web research & synthesis +6. [Team Handoff](workflows/team-handoff.md) β€” Dev ↔ Non-dev patterns + +
+ +--- + +## πŸ“š What's Inside + +### Core Guides (6 files) | Guide | Description | Reading Time | |-------|-------------|--------------| @@ -71,7 +134,7 @@ Prompt: "Organize the files in ~/Cowork-Workspace/ by type" | [Security](guide/03-security.md) | Best practices, risk mitigation, safe usage | 12 min | | [Troubleshooting](guide/04-troubleshooting.md) | Common issues, decision tree, recovery | 8 min | -### Workflows +### Workflows (5 guides) | Workflow | Use Case | Complexity | |----------|----------|------------| @@ -81,30 +144,55 @@ Prompt: "Organize the files in ~/Cowork-Workspace/ by type" | [Meeting Prep](workflows/meeting-prep.md) | Research β†’ briefing document | Intermediate | | [Team Handoff](workflows/team-handoff.md) | Dev ↔ Non-dev patterns | Advanced | -### Ready-to-Use Prompts +
+Ready-to-Use Prompts (60+ prompts) | Collection | Count | Description | |------------|-------|-------------| -| [File Operations](prompts/file-ops.md) | 15+ | Organization, renaming, cleanup | -| [Document Creation](prompts/document-creation.md) | 15+ | Reports, summaries, presentations | -| [Data Extraction](prompts/data-extraction.md) | 15+ | Images β†’ data, PDF parsing | -| [Research](prompts/research.md) | 10+ | Web research, synthesis | +| [File Operations](prompts/file-ops.md) | 20 | Organization, renaming, cleanup, deduplication | +| [Document Creation](prompts/document-creation.md) | 15 | Reports, summaries, presentations, Excel | +| [Data Extraction](prompts/data-extraction.md) | 15 | Images β†’ data, PDF parsing, OCR | +| [Research](prompts/research.md) | 17 | Web research, synthesis, competitive analysis | -### Reference +**Total**: 67 copy-paste prompts + +
+ +
+Reference Materials | Resource | Description | |----------|-------------| | [Cheatsheet](reference/cheatsheet.md) | 1-page printable quick reference | -| [Comparison](reference/comparison.md) | Code vs Cowork vs Projects decision matrix | +| [Comparison](reference/comparison.md) | Cowork vs Copilot/Gemini/ChatGPT/Apple Intelligence | | [FAQ](reference/faq.md) | 20+ frequently asked questions | | [Glossary](reference/glossary.md) | Cowork-specific terminology | -### Templates +
+ +
+Templates | Template | Use Case | |----------|----------| | [CLAUDE.md for Cowork](examples/CLAUDE.md) | Project context file template | +
+ +--- + +## πŸ”‘ Golden Rules + +1. **Always review the plan** before approval β€” Cowork proposes, you decide +2. **Dedicated workspace only** β€” Never grant access to Documents/Desktop/system folders +3. **No credentials in workspace** β€” Keep secrets out of Cowork-accessible folders +4. **Verify file sources** β€” Prompt injection risk in untrusted files (PDFs, docs) +5. **Budget error correction time** β€” OCR accuracy ~97% fields, ~63% line items +6. **Disconnect VPN** β€” #1 issue: VPN breaks VM networking +7. **Backup before destructive ops** β€” No undo for file deletions + +> See [Security Guide](guide/03-security.md) for detailed practices. + --- ## Key Differences: Code vs Cowork @@ -116,45 +204,96 @@ Prompt: "Organize the files in ~/Cowork-Workspace/ by type" | **Execute code** | Yes | No | | **File access** | Full filesystem | Sandboxed folder | | **Outputs** | Any file type | Office docs, Excel, PDF | +| **Browser automation** | Yes (Chrome) | Yes (Chrome) | | **Maturity** | Production-ready | Research preview | β†’ [Full Comparison](reference/comparison.md) --- -## Safety First +## 🌍 About -Cowork has no official security documentation yet. Follow these practices: +
+Origins & Philosophy -1. **Dedicated workspace** β€” Never grant access to Documents or Desktop -2. **Review plans** β€” Check each step before execution -3. **No sensitive data** β€” Keep credentials out of workspace -4. **Backup first** β€” Before destructive operations +This Cowork documentation is part of the [Claude Code Ultimate Guide](../README.md), created after several months of AI-assisted development practice. -β†’ [Complete Security Guide](guide/03-security.md) +**Philosophy**: Practical over theoretical. Real use cases over feature lists. Understanding **why** before **how**. ---- +**Created with Claude Code**. Community-validated through testing and feedback. -## Current Limitations (January 2026) +**Related**: [Claude Code Ultimate Guide](../README.md) β€” For developers +
+ +
+Privacy & Data + +Cowork sends your prompts, file contents, and results to Anthropic servers. + +- **Default**: 5 years retention (training enabled) +- **Opt-out**: 30 days retention +- **Enterprise**: 0 retention + +**Action**: [Disable training](https://claude.ai/settings/data-privacy-controls) | [Data Privacy Guide](../guide/data-privacy.md) + +
+ +
+Current Limitations (January 2026) + +**Platform & Access**: - macOS only (Windows planned, Linux not announced) - Pro ($20/mo) or Max ($100-200/mo) subscription required -- Usage limits: resets every 5 hours, heavy tasks consume quota fast -- No cloud storage connectors confirmed - Research preview = expect bugs + +**Technical Constraints**: +- VPN incompatible (VM routing conflict) +- Usage limits: resets every 5 hours +- Pro tier: ~1-1.5h intensive use before quota exhaustion +- Context limit: ~165K effective (not 200K) +- No cloud storage connectors confirmed - No official security documentation -> ⚠️ **Usage Warning**: File organization and document processing tasks consume tokens rapidly. Pro tier may exhaust quota in 1-1.5 hours of intensive use. Max tier recommended for heavy workflows. +β†’ [Complete Limitations](guide/02-capabilities.md#what-cowork-cannot-do) + +
+ +
+Roadmap & Future Repository + +**Current Status**: Cowork documentation lives in the [Claude Code Ultimate Guide](https://github.com/FlorianBruniaux/claude-code-ultimate-guide) repository. + +**Future Plan**: Migrate to dedicated `claude-cowork-guide` repository when: +- Feature reaches stable release (exit research preview) +- Documentation exceeds 50+ files +- Community requests standalone resource + +**Why separate?**: Different audiences (knowledge workers vs developers), independent versioning, focused contribution guidelines. + +**Timeline**: TBD, depends on Cowork maturity and community feedback. + +
--- -## Contributing +## 🀝 Contributing -Found an issue or have a workflow to share? +Found an error? Have a workflow to share? -1. Open an issue in the main [claude-code-ultimate-guide](https://github.com/your-repo) repo -2. Tag with `[cowork]` prefix -3. Include platform, subscription tier, and reproduction steps +**For now**: Open an issue in the main [claude-code-ultimate-guide](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/issues) repo with `[cowork]` prefix. + +**Include**: Platform, subscription tier, reproduction steps. + +**Future**: Dedicated repo with Cowork-specific contribution guidelines. + +--- + +## πŸ“„ License & Support + +Licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/). Free to share and adapt with attribution. + +**Stay Updated**: [Watch releases](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/releases) | [Discussions](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/discussions) | [Connect on LinkedIn](https://www.linkedin.com/in/florian-bruniaux-43408b83/) --- @@ -163,32 +302,32 @@ Found an issue or have a workflow to share? ``` cowork/ β”œβ”€β”€ README.md ← You are here -β”œβ”€β”€ guide/ +β”œβ”€β”€ guide/ # Core documentation (6 files) β”‚ β”œβ”€β”€ 00-overview.md β”‚ β”œβ”€β”€ 01-getting-started.md β”‚ β”œβ”€β”€ 02-capabilities.md β”‚ β”œβ”€β”€ 03-security.md β”‚ └── 04-troubleshooting.md -β”œβ”€β”€ workflows/ +β”œβ”€β”€ workflows/ # Step-by-step guides (5 files) β”‚ β”œβ”€β”€ file-organization.md β”‚ β”œβ”€β”€ expense-tracking.md β”‚ β”œβ”€β”€ report-synthesis.md β”‚ β”œβ”€β”€ meeting-prep.md β”‚ └── team-handoff.md -β”œβ”€β”€ prompts/ +β”œβ”€β”€ prompts/ # 60+ ready-to-use prompts (4 files) β”‚ β”œβ”€β”€ file-ops.md β”‚ β”œβ”€β”€ document-creation.md β”‚ β”œβ”€β”€ data-extraction.md β”‚ └── research.md -β”œβ”€β”€ reference/ +β”œβ”€β”€ reference/ # Quick references (4 files) β”‚ β”œβ”€β”€ cheatsheet.md β”‚ β”œβ”€β”€ comparison.md β”‚ β”œβ”€β”€ faq.md β”‚ └── glossary.md -└── examples/ +└── examples/ # Templates (1 file) └── CLAUDE.md ``` --- -*Part of [Claude Code Ultimate Guide](../README.md) | [Main Guide](../guide/ultimate-guide.md)* +*Version 1.0.0 | January 2026 | Part of [Claude Code Ultimate Guide](../README.md) | Crafted with Claude* diff --git a/cowork/VERSION b/cowork/VERSION new file mode 100644 index 0000000..3eefcb9 --- /dev/null +++ b/cowork/VERSION @@ -0,0 +1 @@ +1.0.0 diff --git a/cowork/scripts/check-version-sync.sh b/cowork/scripts/check-version-sync.sh new file mode 100755 index 0000000..d088ab6 --- /dev/null +++ b/cowork/scripts/check-version-sync.sh @@ -0,0 +1,122 @@ +#!/usr/bin/env bash +# +# check-version-sync.sh +# Verify that VERSION is synchronized across all Cowork documentation files +# +# Usage: ./scripts/check-version-sync.sh +# Exit codes: 0 = all synced, >0 = number of issues found + +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +COWORK_ROOT="$(dirname "$SCRIPT_DIR")" + +# Colors for output +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +NC='\033[0m' # No Color + +echo "=== Cowork Version Sync Check ===" +echo + +# Read VERSION file +if [[ ! -f "$COWORK_ROOT/VERSION" ]]; then + echo -e "${RED}ERROR: VERSION file not found${NC}" + exit 1 +fi + +VERSION=$(cat "$COWORK_ROOT/VERSION" | tr -d '[:space:]') +echo -e "Source VERSION file: ${GREEN}$VERSION${NC}" +echo + +issues=0 + +# Check 1: README.md version badge +echo "1. Checking README.md version badge..." +README="$COWORK_ROOT/README.md" +if [[ -f "$README" ]]; then + readme_version=$(grep -o 'Version-[0-9.]*-orange' "$README" | head -1 | sed 's/Version-//' | sed 's/-orange//') + if [[ "$readme_version" == "$VERSION" ]]; then + echo -e " ${GREEN}βœ“${NC} README.md badge: $readme_version" + else + echo -e " ${RED}βœ—${NC} README.md badge: $readme_version (expected: $VERSION)" + echo " Fix: Line ~15, update badge to: Version-$VERSION-orange" + ((issues++)) + fi +else + echo -e " ${YELLOW}⚠${NC} README.md not found" +fi + +# Check 2: README.md footer +echo "2. Checking README.md footer..." +if [[ -f "$README" ]]; then + footer_version=$(grep -o 'Version [0-9.]*' "$README" | tail -1 | sed 's/Version //') + if [[ "$footer_version" == "$VERSION" ]]; then + echo -e " ${GREEN}βœ“${NC} README.md footer: $footer_version" + else + echo -e " ${RED}βœ—${NC} README.md footer: $footer_version (expected: $VERSION)" + echo " Fix: Last line, update to: Version $VERSION" + ((issues++)) + fi +fi + +# Check 3: CHANGELOG.md latest version +echo "3. Checking CHANGELOG.md..." +CHANGELOG="$COWORK_ROOT/CHANGELOG.md" +if [[ -f "$CHANGELOG" ]]; then + changelog_version=$(grep -o '\[.*\]' "$CHANGELOG" | head -1 | tr -d '[]') + if [[ "$changelog_version" == "$VERSION" ]]; then + echo -e " ${GREEN}βœ“${NC} CHANGELOG.md latest: $changelog_version" + else + echo -e " ${RED}βœ—${NC} CHANGELOG.md latest: $changelog_version (expected: $VERSION)" + echo " Fix: Line ~9, ensure ## [$VERSION] exists as latest release" + ((issues++)) + fi +else + echo -e " ${YELLOW}⚠${NC} CHANGELOG.md not found" +fi + +# Check 4: cowork-reference.yaml version +echo "4. Checking machine-readable/cowork-reference.yaml..." +REFERENCE="$COWORK_ROOT/../machine-readable/cowork-reference.yaml" +if [[ -f "$REFERENCE" ]]; then + reference_version=$(grep '^version:' "$REFERENCE" | head -1 | sed 's/version: *//' | tr -d '"') + if [[ "$reference_version" == "$VERSION" ]]; then + echo -e " ${GREEN}βœ“${NC} cowork-reference.yaml: $reference_version" + else + echo -e " ${RED}βœ—${NC} cowork-reference.yaml: $reference_version (expected: $VERSION)" + echo " Fix: Line ~6, update to: version: \"$VERSION\"" + ((issues++)) + fi +else + echo -e " ${YELLOW}⚠${NC} cowork-reference.yaml not found" +fi + +# Check 5: Parent README.md (main repo) +echo "5. Checking parent README.md Cowork section..." +PARENT_README="$COWORK_ROOT/../README.md" +if [[ -f "$PARENT_README" ]]; then + # Look for "New in vX.X.X" or similar version references in Cowork section + if grep -A 20 "Claude Cowork" "$PARENT_README" | grep -q "New in v$VERSION"; then + echo -e " ${GREEN}βœ“${NC} Parent README mentions v$VERSION" + else + echo -e " ${YELLOW}⚠${NC} Parent README may need Cowork version update" + echo " Check: Line ~308, ensure 'New in v$VERSION' is mentioned" + fi +else + echo -e " ${YELLOW}⚠${NC} Parent README.md not found" +fi + +echo +echo "=== Summary ===" +if [[ $issues -eq 0 ]]; then + echo -e "${GREEN}All version references are synchronized!${NC}" + exit 0 +else + echo -e "${RED}Found $issues version mismatch(es)${NC}" + echo + echo "To fix all at once, run:" + echo " cd $COWORK_ROOT && ./scripts/sync-version.sh" + exit $issues +fi diff --git a/cowork/scripts/sync-version.sh b/cowork/scripts/sync-version.sh new file mode 100755 index 0000000..aa9726b --- /dev/null +++ b/cowork/scripts/sync-version.sh @@ -0,0 +1,102 @@ +#!/usr/bin/env bash +# +# sync-version.sh +# Synchronize VERSION across all Cowork documentation files +# +# Usage: ./scripts/sync-version.sh [--check] +# --check: Only check, don't modify files (same as check-version-sync.sh) +# +# Example: echo "1.1.0" > VERSION && ./scripts/sync-version.sh + +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +COWORK_ROOT="$(dirname "$SCRIPT_DIR")" + +# Colors +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +NC='\033[0m' + +# Check-only mode +if [[ "${1:-}" == "--check" ]]; then + exec "$SCRIPT_DIR/check-version-sync.sh" +fi + +echo "=== Cowork Version Sync ===" +echo + +# Read VERSION file +if [[ ! -f "$COWORK_ROOT/VERSION" ]]; then + echo "ERROR: VERSION file not found" + exit 1 +fi + +VERSION=$(cat "$COWORK_ROOT/VERSION" | tr -d '[:space:]') +echo -e "Syncing to version: ${GREEN}$VERSION${NC}" +echo + +# Get current date for CHANGELOG +CURRENT_DATE=$(date +%Y-%m-%d) + +# 1. Update README.md version badge +echo "1. Updating README.md version badge..." +README="$COWORK_ROOT/README.md" +if [[ -f "$README" ]]; then + sed -i.bak "s/Version-[0-9.]*-orange/Version-$VERSION-orange/" "$README" + rm "${README}.bak" + echo -e " ${GREEN}βœ“${NC} Badge updated" +else + echo -e " ${YELLOW}⚠${NC} README.md not found" +fi + +# 2. Update README.md footer +echo "2. Updating README.md footer..." +if [[ -f "$README" ]]; then + # Update last line with version + date + sed -i.bak "$ s/Version [0-9.]*.*$/Version $VERSION | $(date +"%B %Y") | Part of [Claude Code Ultimate Guide](..\/README.md) | Crafted with Claude*/" "$README" + rm "${README}.bak" + echo -e " ${GREEN}βœ“${NC} Footer updated" +fi + +# 3. Check CHANGELOG.md has entry +echo "3. Checking CHANGELOG.md..." +CHANGELOG="$COWORK_ROOT/CHANGELOG.md" +if [[ -f "$CHANGELOG" ]]; then + if grep -q "## \[$VERSION\]" "$CHANGELOG"; then + echo -e " ${GREEN}βœ“${NC} CHANGELOG already has [$VERSION] entry" + else + echo -e " ${YELLOW}⚠${NC} CHANGELOG missing [$VERSION] - add manually" + echo " Add this after line 7:" + echo " ## [$VERSION] - $CURRENT_DATE" + fi +else + echo -e " ${YELLOW}⚠${NC} CHANGELOG.md not found" +fi + +# 4. Update cowork-reference.yaml +echo "4. Updating cowork-reference.yaml..." +REFERENCE="$COWORK_ROOT/../machine-readable/cowork-reference.yaml" +if [[ -f "$REFERENCE" ]]; then + sed -i.bak "s/^version: *\".*\"/version: \"$VERSION\"/" "$REFERENCE" + sed -i.bak "s/^updated: *\".*\"/updated: \"$CURRENT_DATE\"/" "$REFERENCE" + rm "${REFERENCE}.bak" + echo -e " ${GREEN}βœ“${NC} Reference YAML updated" +else + echo -e " ${YELLOW}⚠${NC} cowork-reference.yaml not found" +fi + +# 5. Reminder for parent README +echo "5. Parent README.md..." +echo -e " ${YELLOW}β„Ή${NC} Manually update parent README.md if needed" +echo " Check line ~308 for Cowork section version references" + +echo +echo "=== Summary ===" +echo -e "${GREEN}Version synchronized to $VERSION${NC}" +echo +echo "Next steps:" +echo " 1. Review changes: git diff" +echo " 2. Run verification: ./scripts/check-version-sync.sh" +echo " 3. Update CHANGELOG.md if needed" +echo " 4. Commit: git add . && git commit -m \"docs(cowork): bump version to $VERSION\"" diff --git a/cowork/scripts/update-stats.sh b/cowork/scripts/update-stats.sh new file mode 100755 index 0000000..d86f026 --- /dev/null +++ b/cowork/scripts/update-stats.sh @@ -0,0 +1,127 @@ +#!/usr/bin/env bash +# +# update-stats.sh +# Update statistics in Cowork README (prompts count, workflows count, files count) +# +# Usage: ./scripts/update-stats.sh [--check] +# --check: Only show stats, don't modify files +# +# Run this after adding/removing prompts or workflows + +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +COWORK_ROOT="$(dirname "$SCRIPT_DIR")" + +# Colors +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +BLUE='\033[0;34m' +NC='\033[0m' + +CHECK_ONLY=false +if [[ "${1:-}" == "--check" ]]; then + CHECK_ONLY=true +fi + +echo "=== Cowork Statistics Update ===" +echo + +# Count prompts per category +echo -e "${BLUE}Counting prompts...${NC}" +FILE_OPS_COUNT=$(grep -c '^###' "$COWORK_ROOT/prompts/file-ops.md" 2>/dev/null || echo "0") +DOC_CREATE_COUNT=$(grep -c '^###' "$COWORK_ROOT/prompts/document-creation.md" 2>/dev/null || echo "0") +DATA_EXTRACT_COUNT=$(grep -c '^###' "$COWORK_ROOT/prompts/data-extraction.md" 2>/dev/null || echo "0") +RESEARCH_COUNT=$(grep -c '^###' "$COWORK_ROOT/prompts/research.md" 2>/dev/null || echo "0") + +TOTAL_PROMPTS=$((FILE_OPS_COUNT + DOC_CREATE_COUNT + DATA_EXTRACT_COUNT + RESEARCH_COUNT)) + +echo " File Operations: $FILE_OPS_COUNT" +echo " Document Creation: $DOC_CREATE_COUNT" +echo " Data Extraction: $DATA_EXTRACT_COUNT" +echo " Research: $RESEARCH_COUNT" +echo " ${GREEN}Total Prompts: $TOTAL_PROMPTS${NC}" +echo + +# Count workflows +echo -e "${BLUE}Counting workflows...${NC}" +WORKFLOWS_COUNT=$(find "$COWORK_ROOT/workflows" -name "*.md" -not -name "README.md" 2>/dev/null | wc -l | tr -d ' ') +echo " ${GREEN}Total Workflows: $WORKFLOWS_COUNT${NC}" +echo + +# Count guide files +echo -e "${BLUE}Counting guide files...${NC}" +GUIDES_COUNT=$(find "$COWORK_ROOT/guide" -name "*.md" 2>/dev/null | wc -l | tr -d ' ') +echo " ${GREEN}Total Guides: $GUIDES_COUNT${NC}" +echo + +# Count reference files +echo -e "${BLUE}Counting reference files...${NC}" +REFERENCE_COUNT=$(find "$COWORK_ROOT/reference" -name "*.md" 2>/dev/null | wc -l | tr -d ' ') +echo " ${GREEN}Total Reference Files: $REFERENCE_COUNT${NC}" +echo + +# Total documentation files +TOTAL_FILES=$((GUIDES_COUNT + WORKFLOWS_COUNT + REFERENCE_COUNT + 1)) # +1 for README +echo -e "${GREEN}Total Documentation Files: $TOTAL_FILES${NC}" +echo + +if [[ "$CHECK_ONLY" == true ]]; then + echo "=== Check Only Mode ===" + echo "No files modified. Run without --check to update README.md" + exit 0 +fi + +# Update README.md badges +echo "=== Updating README.md ===" + +README="$COWORK_ROOT/README.md" +if [[ ! -f "$README" ]]; then + echo "ERROR: README.md not found" + exit 1 +fi + +# Create backup +cp "$README" "${README}.bak" + +# Update prompts badge +sed -i.tmp "s/Prompts-[0-9]*+-green/Prompts-${TOTAL_PROMPTS}+-green/" "$README" + +# Update workflows badge +sed -i.tmp "s/Workflows-[0-9]*-blue/Workflows-${WORKFLOWS_COUNT}-blue/" "$README" + +# Update prompts table in "Ready-to-Use Prompts" collapsible +sed -i.tmp "s/| \[File Operations\](prompts\/file-ops.md) | [0-9]*/| [File Operations](prompts\/file-ops.md) | $FILE_OPS_COUNT/" "$README" +sed -i.tmp "s/| \[Document Creation\](prompts\/document-creation.md) | [0-9]*/| [Document Creation](prompts\/document-creation.md) | $DOC_CREATE_COUNT/" "$README" +sed -i.tmp "s/| \[Data Extraction\](prompts\/data-extraction.md) | [0-9]*/| [Data Extraction](prompts\/data-extraction.md) | $DATA_EXTRACT_COUNT/" "$README" +sed -i.tmp "s/| \[Research\](prompts\/research.md) | [0-9]*/| [Research](prompts\/research.md) | $RESEARCH_COUNT/" "$README" + +# Update total prompts line +sed -i.tmp "s/\*\*Total\*\*: [0-9]* copy-paste prompts/**Total**: $TOTAL_PROMPTS copy-paste prompts/" "$README" + +# Clean up temp files +rm "${README}.tmp" 2>/dev/null || true + +# Show diff if changes were made +if ! diff -q "$README" "${README}.bak" > /dev/null 2>&1; then + echo -e "${GREEN}βœ“ README.md updated${NC}" + echo + echo "Changes made:" + diff -u "${README}.bak" "$README" | grep '^[+-]' | grep -v '^[+-][+-][+-]' | head -20 + rm "${README}.bak" +else + echo -e "${YELLOW}No changes needed${NC}" + rm "${README}.bak" +fi + +echo +echo "=== Summary ===" +echo "Statistics:" +echo " β€’ Prompts: $TOTAL_PROMPTS ($FILE_OPS_COUNT + $DOC_CREATE_COUNT + $DATA_EXTRACT_COUNT + $RESEARCH_COUNT)" +echo " β€’ Workflows: $WORKFLOWS_COUNT" +echo " β€’ Guide Files: $GUIDES_COUNT" +echo " β€’ Total Documentation: $TOTAL_FILES files" +echo +echo "Next steps:" +echo " 1. Review changes: git diff cowork/README.md" +echo " 2. Commit: git add cowork/README.md && git commit -m \"docs(cowork): update stats\"" diff --git a/cowork/tools/cowork-onboarding.md b/cowork/tools/cowork-onboarding.md new file mode 100644 index 0000000..d12871e --- /dev/null +++ b/cowork/tools/cowork-onboarding.md @@ -0,0 +1,389 @@ +# Personalized Cowork Onboarding + +> An interactive prompt for Claude to guide you through Cowork documentation at your own pace. + +**Author**: [Florian BRUNIAUX](https://github.com/FlorianBruniaux) | Founding Engineer [@MΓ©thode Aristote](https://methode-aristote.fr) + +**Reference**: [Cowork Documentation](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/tree/main/cowork) + +--- + +## 1. What This Does + +This prompt instructs Claude (in Claude Desktop) to become your personal Cowork coach by: + +1. **Profiling** you with 3 quick questions (goal + style + level) +2. **Loading** the Cowork reference index for smart navigation +3. **Routing** you to the right content based on your profile +4. **Guiding** you progressively with depth control (deeper/next/skip/reset) +5. **Adapting** to your preferred language and communication style + +**Experience**: 3 questions β†’ tailored content β†’ interactive exploration. + +**Time**: 5-60 minutes depending on your goal and available time. + +--- + +## 2. Who This Is For + +| Goal | What You'll Get | +|------|-----------------| +| **Organize files** | File organization workflow + prompts | +| **Create documents** | Report synthesis + document creation prompts | +| **Extract data** | OCR workflow + data extraction prompts | +| **Research** | Web research workflow + prompts | +| **Learn everything** | Complete guided tour | + +**Prerequisites**: Claude Desktop with Cowork enabled (or wanting to learn about it) + +--- + +## 3. How to Use It + +### Option A: One-liner (no download needed) + +**In Claude Desktop**, paste this: + +``` +Fetch and follow the Cowork onboarding instructions from: https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate-guide/main/cowork/tools/cowork-onboarding.md +``` + +### Option B: From documentation + +1. Copy everything in [Section 4](#4-the-prompt) below +2. Open **Claude Desktop** +3. Paste the prompt and press Enter + +> **Note**: This onboarding is interactive. Claude will ask you questions to personalize your learning path. + +--- + +## 4. The Prompt + +```markdown +# Personalized Cowork Onboarding + +## Your Role + +You are an expert Cowork instructor. Your mission is to onboard me using the Cowork reference index as your navigation map. + +## Instructions + +### Phase 0: Quick Profile (3 mandatory questions) + +**IMPORTANT: Ask questions conversationally** - Cowork is for desktop use, so present options clearly in your response. + +**Ask ONE AT A TIME:** + +1. **Language**: What language do you prefer? + - English + - FranΓ§ais + - EspaΓ±ol + - Other (specify) + +2. **Goal**: After language, ask what they want to accomplish: + - πŸ“ Organize files - Clean up Downloads, organize folders + - πŸ“„ Create documents - Reports, presentations, Excel files + - πŸ” Extract data - OCR from images, receipts, invoices + - πŸ”¬ Research - Web research, competitive analysis + - πŸ“š Learn everything - Complete guided tour + +3. **Communication style**: After goal: + - πŸŽ“ Pedagogical - Detailed explanations, understand the "why" + - ⚑ Direct - Straight to the point, no fluff + - 🧭 Coaching - Guide me with questions, let me discover + - πŸ”„ Adaptive - Mix styles based on topic complexity + +### Phase 1: Load Knowledge Index + +**Fetch the Cowork navigation index:** + +``` +https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate-guide/main/machine-readable/cowork-reference.yaml +``` + +**This file contains:** +- `docs`: All documentation paths +- `prompts`: 60+ ready-to-use prompts organized by category +- `workflows`: 5 step-by-step workflows +- `essentials`: Platform, pricing, limits, capabilities +- `errors`: Common error messages and solutions +- `rules`: 7 Golden Rules +- `decide`: Decision flowchart + +**Fallback if fetch fails:** +If you cannot fetch cowork-reference.yaml: +1. Acknowledge: "I couldn't fetch the navigation index, but I can still help you." +2. Use this embedded fallback roadmap: + - `organize_files`: file-ops prompts β†’ file-organization workflow + - `create_documents`: document-creation prompts β†’ report-synthesis workflow + - `extract_data`: data-extraction prompts β†’ expense-tracking workflow + - `research`: research prompts β†’ meeting-prep workflow +3. Continue with Phase 1.5 questions as normal. + +### Phase 1.5: Refine Profile (progressive - based on goal) + +Based on the goal from Phase 0, ask ONLY the necessary additional questions: + +| Goal | Additional Questions | +|------|---------------------| +| `organize_files` | Level + Time | +| `create_documents` | Level + Time | +| `extract_data` | Level + Time | +| `research` | Level + Time | +| `learn_everything` | Level + Time + Style | + +**Level question**: +- 🟒 Beginner - Never used Cowork / just enabled +- 🟑 Intermediate - Used a few times, want to optimize +- πŸ”΄ Power User - Regular user, want advanced tips + +**Time question**: +- ⚑ 5-10 min - Quick essentials +- ⏱️ 15-30 min - Core workflow + tips +- 🎯 30-60 min - Complete deep dive +- πŸ“š 1+ hour - Everything + +**Style question** (if time >= 30min): +- πŸ“– Explanations - Tell me why things work +- πŸ’» Examples - Show me real prompts +- 🎯 Quick reference - Just the facts +- πŸ‹οΈ Hands-on - Let me try immediately + +### Phase 2: Route and Present + +1. **Build profile key**: `{goal}.{level}_{time}` + - Example: `organize_files.beginner_15min` + +2. **Always show FIRST (before any content):** + + **⚠️ Before You Start**: + - **Platform**: macOS only (Windows planned, no ETA) + - **Subscription**: Pro ($20/mo) or Max ($100-200/mo) required + - **VPN Warning**: Disconnect VPN before using Cowork (VM routing conflict) + - **Workspace**: Create dedicated ~/Cowork-Workspace/ folder + + **7 Golden Rules**: + 1. Always review the plan before approval + 2. Dedicated workspace only (never Documents/Desktop) + 3. No credentials in workspace + 4. Verify file sources (prompt injection risk) + 5. Budget error correction time (OCR ~97% fields, ~63% line items) + 6. Disconnect VPN (#1 issue) + 7. Backup before destructive operations + +3. **Then present the content roadmap:** + - List the topics based on their goal + - Ask: "Which topic would you like to explore first?" or "Start with the first topic?" + +### Phase 3: Interactive Exploration + +**For each topic in the roadmap:** + +1. **Locate content**: Use the cowork-reference.yaml paths to find relevant files: + - Guides: `docs.{topic}` β†’ file path + - Prompts: `prompts.{category}` β†’ file path + - Workflows: `workflows.{workflow}` β†’ file path + +2. **Fetch and summarize**: Get the relevant section from the documentation + +3. **Present summary**: 2-4 key points adapted to BOTH style AND tone preferences: + + **Style** (WHAT to emphasize): + - `explain` β†’ Focus on WHY and concepts (e.g., "CTOC framework helps because...") + - `examples` β†’ Lead with real prompts (e.g., "Here's a prompt: 'Organize ~/Downloads by type'") + - `reference` β†’ Bullet points, no prose (e.g., "β€’ Platform: macOS β€’ Pricing: $20-200/mo") + - `handson` β†’ Give them something to try immediately (e.g., "Try this prompt right now: ...") + + **Tone** (HOW to deliver): + - `pedagogical` β†’ Explain reasoning, use analogies, connect concepts + - `direct` β†’ State facts concisely, action-focused + - `coaching` β†’ Ask questions first, guide discovery + - `adaptive` β†’ Start direct, expand if user asks "why?" + +4. **Show prompts when relevant**: Include actual copy-paste prompts from the prompts library: + ``` + CONTEXT: [situation] + TASK: [what to do] + OUTPUT: [format and location] + CONSTRAINTS: [rules] + ``` + +5. **Depth control**: Ask after each topic: + - "Go deeper" β†’ Provide detailed explanation with more examples + - "Next topic" β†’ Brief summary, move forward + - "Skip" β†’ Skip topic (mention what's being skipped briefly) + - "Show prompt" β†’ Display a ready-to-use prompt for this topic + - "Reset" β†’ Restart onboarding with different preferences + +6. **Handle questions**: If user asks something specific, use cowork-reference.yaml to find relevant section + +### Phase 4: Wrap-up + +Based on time spent and topics covered: + +1. **Recap**: Summarize what was covered (3-5 bullet points) + +2. **Quick wins**: Suggest 1-2 immediate actions based on their goal: + - `organize_files` β†’ "Create ~/Cowork-Workspace/ and try organizing your Downloads folder" + - `create_documents` β†’ "Try the expense tracking workflow with a few receipts" + - `extract_data` β†’ "Test OCR on 2-3 receipts to understand accuracy" + - `research` β†’ "Use the competitive analysis prompt for a real project" + +3. **Next steps**: Point to relevant resources with clickable URLs: + - Cheat sheet: [Printable cheatsheet](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/blob/main/cowork/reference/cheatsheet.md) + - Prompts: [60+ ready-to-use prompts](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/tree/main/cowork/prompts) + - Workflows: [5 step-by-step workflows](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/tree/main/cowork/workflows) + - FAQ: [20+ questions answered](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/blob/main/cowork/reference/faq.md) + +4. **Troubleshooting reminder**: If they encounter issues: + - VPN: Disconnect before using + - VM timeout: Common error, see [troubleshooting guide](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/blob/main/cowork/guide/04-troubleshooting.md) + - Context limits: Break tasks into smaller batches (10-20 files max) + +### Privacy Notice (show once, after Phase 2) + +⚠️ **Data Privacy Reminder**: +- Everything you share with Cowork is sent to Anthropic servers +- Default retention: **5 years** (training enabled) +- Action: [Disable training](https://claude.ai/settings/data-privacy-controls) β†’ reduces to 30 days +- Details: [Data Privacy Guide](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/blob/main/guide/data-privacy.md) + +## Output Format + +- Use tables for structured information +- Use CTOC format for prompts (Contextβ†’Taskβ†’Outputβ†’Constraints) +- Keep explanations concise unless user asks for details +- Always end sections with a question to keep it interactive +- Respond in user's preferred language throughout + +## Key Principles + +1. **Fast**: 3 quick questions before delivering value +2. **Targeted**: Content matches goal, not generic overview +3. **Interactive**: User controls pace and depth +4. **Practical**: Focus on actionable knowledge (prompts, workflows) +5. **Multilingual**: Full conversation in preferred language +6. **Adaptable**: Users can reset and change preferences anytime +7. **Prompt-first**: Always show copy-paste prompts when relevant + +## Start Now + +Begin by asking about preferred language. + +--- +*Portability: This prompt works in Claude Desktop with Cowork enabled. For learning without Cowork access, it still provides valuable documentation guidance.* +``` + +--- + +## 5. Example Interaction + +**Claude**: What language do you prefer for this onboarding? + +**You**: English + +**Claude**: Great! What do you want to accomplish with Cowork? +- πŸ“ **Organize files** - Clean up Downloads, organize folders +- πŸ“„ **Create documents** - Reports, presentations, Excel files +- πŸ” **Extract data** - OCR from images, receipts, invoices +- πŸ”¬ **Research** - Web research, competitive analysis +- πŸ“š **Learn everything** - Complete guided tour + +**You**: Extract data + +**Claude**: What's your experience level with Cowork? +- 🟒 Beginner +- 🟑 Intermediate +- πŸ”΄ Power User + +**You**: Beginner + +**Claude**: How much time do you have? +- ⚑ 5-10 min +- ⏱️ 15-30 min +- 🎯 30-60 min + +**You**: 15-30 min + +**Claude**: +*[Loads cowork-reference.yaml, looks up data extraction workflow]* + +**⚠️ Before You Start**: +- Platform: macOS only +- Subscription: Pro or Max required +- ⚠️ Disconnect VPN before using Cowork + +**7 Golden Rules**: +1. Always review the plan before approval +2. Dedicated workspace only +3. No credentials in workspace +4. Verify file sources +5. Budget error correction time (OCR ~97% fields, ~63% line items) +6. Disconnect VPN +7. Backup before destructive ops + +**Your Learning Path** (3 topics, ~15 min): +1. OCR capabilities and accuracy +2. Expense tracking workflow +3. Data extraction prompts + +Which topic would you like to start with? + +**You**: OCR capabilities + +**Claude**: +**OCR Capabilities in Cowork** + +Cowork can extract text from images (receipts, invoices, screenshots): + +βœ… **What works well** (~97% accuracy): +- Vendor names +- Dates +- Total amounts +- Single-currency receipts + +⚠️ **What's challenging** (~63% accuracy): +- Line items in tables +- Handwritten text +- Multi-currency receipts +- Faded or low-quality scans + +**Important**: Budget 30-50% of "saved" time for error correction. OCR is a starting point, not a final result. + +**Real example**: 10 receipts β†’ Excel takes 20 min vs 60 min manual. But you'll spend 5-10 min fixing errors. + +Would you like to: +- "Go deeper" on OCR accuracy +- "Next topic" (expense tracking workflow) +- "Show prompt" (see a data extraction prompt) + +--- + +## 6. Tips for Best Results + +| Tip | Why It Helps | +|-----|--------------| +| **Be honest about your level** | Gets you the right complexity | +| **Say "show prompt" often** | Cowork is all about ready-to-use prompts | +| **Say "skip" freely** | No need to cover what you know | +| **Ask questions anytime** | Claude will find the relevant section | + +--- + +## 7. Related Resources + +- [Cowork Reference Index](../machine-readable/cowork-reference.yaml) - The navigation map Claude uses +- [Cowork Documentation Hub](../README.md) - Complete documentation +- [Cheat Sheet](../reference/cheatsheet.md) - Print this, start organizing +- [60+ Prompts Library](../prompts/) - Copy-paste prompts +- [5 Workflows](../workflows/) - Step-by-step guides + +--- + +## 8. Feedback + +Found this helpful? Have suggestions? +- Star the repo: [claude-code-ultimate-guide](https://github.com/FlorianBruniaux/claude-code-ultimate-guide) +- Open an issue with `[cowork]` prefix +- Share with others learning Cowork