liveBook · Manning

CLAUDE.md

As explained in Claude at Work

A CLAUDE.md file is a Markdown instruction file that provides Claude Code with project or personal guidance for software development work.

A CLAUDE.md file gives Claude Code project context and working instructions. When it exists in the repository, it is loaded at the start of each session, so future sessions need less repeated orientation. section 5.12 section 5.4

Create guidance that helps a future session start work:

  • Use /init to draft the file from an established codebase or project documentation; choose a project-level file when its instructions should benefit everyone working on the repository. section 5.4 section 5.5
  • Include practical details such as the repository layout, local development and deployment workflows, open decisions, and conventions that are easy to get wrong. section 5.5
  • Review questions and discrepancies raised during setup, and confirm which sources are authoritative. Claude can use tools and access files, so permissions—not a sandbox—provide protection; stricter modes can slow work. section 5.5 section 5.12

A project-specific /init prompt

/init — this repo will build out the whole app specced in the docs/design folder. We will use Docker to run the stack locally, and package with Helm for deployment to Kubernetes. section 5.5

Listing 5.1 The CLAUDE.md file — a guide for AI agents joining the project
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working
with code in this repository.

## What this is

CollabHub — team chat + collaborative canvas. Five Python backend
services and a React SPA, specified in `docs/design/` and being built
out from that spec. Run locally with Docker Compose; deploy to
Kubernetes with Helm.

**Read `docs/design/00-platform-conventions.md` before writing or
changing any service code.** It is the authoritative cross-service
contract (errors, pagination, auth, IDs, jobs, config, observability).
Where a per-service doc disagrees with it, it wins. Per-service specs
are `docs/design/01`–`06`.

A sample file shows how to combine a project description, workflow details, and an explicit instruction about which cross-service conventions to read first. section 5.5

How Claude at Work covers it

How deep it goes
Shows Markdown headings and selected instructions, without prescribing a fixed schema.
Examples
Uses a design-doc-backed app, an /init prompt, Docker, Helm, Kubernetes, and conventions to avoid mistakes.
What it assumes
Starts from a repository or design documents to describe, while recognizing that each new session begins without prior context.
What you can do after
Configure shared project guidance with /init, resolve missing decisions, and review instructions before later sessions rely on them.
How it connects
Connects Claude Code sessions with repository documentation, README-style onboarding, and Markdown instruction files.

Also explained in

Compare how 2 books explain CLAUDE.md →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Claude at Work. The section links point to the parts of the book it draws on.