8f1dcecfa2
- guide/ultimate-guide.md — content updates - guide/workflows/README.md, guide/README.md — navigation improvements - guide/diagrams/ — diagram updates (context/sessions, config, MCP ecosystem) - guide/third-party-tools.md — additions - examples/README.md, hooks/README.md, scripts/README.md — examples updates - examples/skills/pr-triage/SKILL.md — expanded skill - machine-readable/reference.yaml — reference sync - tools/audit-prompt.md, tools/onboarding-prompt.md — tooling updates - docs/for-cto.md, docs/for-tech-leads.md, docs/resource-evaluations/README.md — doc updates - .gitignore — gitignore update Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
89 lines
6.8 KiB
Markdown
89 lines
6.8 KiB
Markdown
---
|
|
title: "Guide Documentation"
|
|
description: "Index of all core documentation files for mastering Claude Code"
|
|
tags: [guide, reference]
|
|
---
|
|
|
|
# Guide Documentation
|
|
|
|
Core documentation for mastering Claude Code.
|
|
|
|
## Contents
|
|
|
|
| File | Description | Time |
|
|
|------|-------------|------|
|
|
| [ultimate-guide.md](./ultimate-guide.md) | Complete reference covering all Claude Code features | ~3 hours |
|
|
| [mcp-servers-ecosystem.md](./mcp-servers-ecosystem.md) | **Community MCP servers**: 8 validated servers (Playwright, Semgrep, Kubernetes, etc.) with production configs | 25 min |
|
|
| [third-party-tools.md](./third-party-tools.md) | **Community tools**: GUIs, TUIs, config managers, token trackers, alternative UIs | 15 min |
|
|
| [claude-code-releases.md](./claude-code-releases.md) | Official release history (condensed) | 10 min |
|
|
| [known-issues.md](./known-issues.md) | **Critical bugs tracker**: security issues, token consumption, verified community reports | 15 min |
|
|
| [cheatsheet.md](./cheatsheet.md) | 1-page printable quick reference | 5 min |
|
|
| [visual-reference.md](./visual-reference.md) | Visual cheatsheet — ASCII diagrams for key concepts | 5 min |
|
|
| [diagrams/](./diagrams/) | **Visual Diagrams Series**: 41 Mermaid interactive diagrams for model selection, agent lifecycle, security, multi-agent patterns | 15 min |
|
|
| [architecture.md](./architecture.md) | How Claude Code works internally (master loop, tools, context) | 25 min |
|
|
| [learning-with-ai.md](./learning-with-ai.md) | Guide for juniors on using AI without losing skills | 15 min |
|
|
| [adoption-approaches.md](./adoption-approaches.md) | Implementation strategies for teams | 15 min |
|
|
| [agent-evaluation.md](./agent-evaluation.md) | **Agent quality metrics**: Measuring custom agent effectiveness with hooks, tests, and feedback loops | 20 min |
|
|
| [data-privacy.md](./data-privacy.md) | Data retention and privacy guide | 10 min |
|
|
| [observability.md](./observability.md) | Session monitoring and cost tracking | 15 min |
|
|
| [methodologies.md](./methodologies.md) | 15 development methodologies reference (TDD, SDD, BDD, etc.) | 20 min |
|
|
| [security-hardening.md](./security-hardening.md) | Security threats, MCP vetting, injection defense | 25 min |
|
|
| [ai-traceability.md](./ai-traceability.md) | AI attribution, disclosure policies, git-ai, compliance | 20 min |
|
|
| [devops-sre.md](./devops-sre.md) | FIRE framework for infrastructure diagnosis and incident response | 30 min |
|
|
| [sandbox-isolation.md](./sandbox-isolation.md) | Docker Sandboxes, cloud alternatives, safe autonomy workflows | 10 min |
|
|
| [ai-ecosystem.md](./ai-ecosystem.md) | Complementary AI tools (Perplexity, Gemini, Kimi, NotebookLM, TTS) | 30 min |
|
|
| [cowork.md](./cowork.md) | Claude Cowork: Summary (see [dedicated repo](https://github.com/FlorianBruniaux/claude-cowork-guide) for full docs) | 5 min |
|
|
| [ai-roles.md](./ai-roles.md) | AI roles mapping: when to use Claude Code vs Claude Desktop vs API | 10 min |
|
|
| [production-safety.md](./production-safety.md) | Production safety: guardrails, review gates, rollback strategies | 15 min |
|
|
| [remarkable-ai.md](./remarkable-ai.md) | Remarkable AI usage patterns and power-user techniques | 10 min |
|
|
| [sandbox-native.md](./sandbox-native.md) | Native Claude Code sandbox: configuration and security model | 10 min |
|
|
| [search-tools-cheatsheet.md](./search-tools-cheatsheet.md) | Search tools quick reference: rg, grepai, Serena, ast-grep | 5 min |
|
|
| [workflows/](./workflows/) | Practical workflow guides for Claude Code | 30 min |
|
|
|
|
### Cowork Documentation
|
|
|
|
For knowledge workers using Claude Cowork (agentic desktop):
|
|
|
|
| Resource | Description |
|
|
|----------|-------------|
|
|
| **[Cowork Hub](https://github.com/FlorianBruniaux/claude-cowork-guide/blob/main/README.md)** | Complete Cowork documentation |
|
|
| [Getting Started](https://github.com/FlorianBruniaux/claude-cowork-guide/blob/main/guide/01-getting-started.md) | Setup and first workflow |
|
|
| [Capabilities](https://github.com/FlorianBruniaux/claude-cowork-guide/blob/main/guide/02-capabilities.md) | What Cowork can/cannot do |
|
|
| [Security Guide](https://github.com/FlorianBruniaux/claude-cowork-guide/blob/main/guide/03-security.md) | Safe usage practices |
|
|
| [Prompt Library](https://github.com/FlorianBruniaux/claude-cowork-guide/tree/main/prompts) | 50+ ready-to-use prompts |
|
|
| [Cheatsheet](https://github.com/FlorianBruniaux/claude-cowork-guide/blob/main/reference/cheatsheet.md) | 1-page quick reference |
|
|
|
|
### Workflows
|
|
|
|
Hands-on guides for effective development patterns:
|
|
|
|
| File | Description |
|
|
|------|-------------|
|
|
| [workflows/tdd-with-claude.md](./workflows/tdd-with-claude.md) | Test-Driven Development with Claude |
|
|
| [workflows/spec-first.md](./workflows/spec-first.md) | Spec-First Development (SDD) |
|
|
| [workflows/plan-driven.md](./workflows/plan-driven.md) | Using /plan mode effectively |
|
|
| [workflows/iterative-refinement.md](./workflows/iterative-refinement.md) | Iterative improvement loops |
|
|
| [workflows/tts-setup.md](./workflows/tts-setup.md) | Add text-to-speech narration to Claude Code (18 min) |
|
|
| [workflows/task-management.md](./workflows/task-management.md) | Multi-session task tracking, TodoWrite migration |
|
|
| [workflows/agent-teams.md](./workflows/agent-teams.md) | Orchestrating multi-agent teams for complex tasks |
|
|
| [workflows/agent-teams-quick-start.md](./workflows/agent-teams-quick-start.md) | Quick start guide for agent team patterns |
|
|
| [workflows/dual-instance-planning.md](./workflows/dual-instance-planning.md) | Dual-instance planning: Opus plans, Sonnet executes |
|
|
| [workflows/event-driven-agents.md](./workflows/event-driven-agents.md) | Event-driven agent coordination patterns |
|
|
| [workflows/plan-pipeline.md](./workflows/plan-pipeline.md) | End-to-end plan pipeline: start, validate, execute |
|
|
| [workflows/design-to-code.md](./workflows/design-to-code.md) | Convert Figma/wireframes to working code |
|
|
| [workflows/exploration-workflow.md](./workflows/exploration-workflow.md) | Systematically explore unfamiliar codebases |
|
|
| [workflows/pdf-generation.md](./workflows/pdf-generation.md) | Generate professional PDFs with Quarto/Typst |
|
|
| [workflows/search-tools-mastery.md](./workflows/search-tools-mastery.md) | Master rg, grepai, Serena, ast-grep combined workflows |
|
|
| [workflows/skeleton-projects.md](./workflows/skeleton-projects.md) | Use battle-tested repos as scaffolding for new projects |
|
|
| [workflows/talk-pipeline.md](./workflows/talk-pipeline.md) | 6-stage talk preparation: raw material to slides |
|
|
| [workflows/team-ai-instructions.md](./workflows/team-ai-instructions.md) | Scale CLAUDE.md across multi-developer teams |
|
|
|
|
## Recommended Reading Order
|
|
|
|
1. **New users**: Start with Quick Start section in `ultimate-guide.md`
|
|
2. **Daily reference**: Print `cheatsheet.md`
|
|
3. **Team leads**: Read `adoption-approaches.md` for rollout strategies
|
|
|
|
---
|
|
|
|
*Back to [main README](../README.md)*
|