agentleFS
lingxiaobclingxiaobc/claude_code_guide/CLAUDE.md

claude_code_guide

CLAUDE.md1 starsChanged 6 months agoMITView on GitHub

这是一个 Claude Code 中文教程创作项目,向零基础用户系统讲解 Claude Code,让他们能够熟练运用 Claude Code 处理自己的项目。 目录结构: - reference/ - 官方参考资料(只读) - claude_code帮助文档/ - 英文官方帮助文档(主要参考来源) - getting started/ - 基础概念、安装、工作流 - build with claude code/ - 高级功能:hooks、MCP、子代理、技能等 - The-Complete-Guide-to-Building-Skill-for-Claude.md - Skill 构建完整指南 - claude_code使用帮助文档/ - 补充说明文档 - claude_code使用教程/ - 中文原创教程(主要工作目录) - 每篇教程放在独立目录,命名格式:<序号>-<教程名称>/ - 目录内包含:<教程名称>.md(正文)+ image/(配图) 编写教程前,*必须*先读取 教程目录.md(项目根目录),根据其中的勾选进度确定下一篇待编写的教程。严格按照目录中列出的顺序和标题编写,禁止自行选题或跳过未完成的条目。 每篇教程必须放在独立目录中,命名格式:序号-教程文章名称 所有文章必须遵守: 1. 每句话单独成段,段与段之间空一行 2. 禁止使用 ASCII 方框字符(┌、─、┐、│、└、┘等),目录树结构除外 3. 重要结论使用 ==**加粗高亮**== 标注 以下三个子代理在教程工作流中*必须按顺序调用*,不得跳过、省略或用其他方式替代: 所有子代理均通过 tools 白名单(仅 Read/Glob/Grep)和 disallowedTools 黑名单(禁止 Write/Edit/Bash/Agent/NotebookEdit)双重限制,确保只读不写,防止越权操作。

The file

Files
CLAUDE.md

CLAUDE.md

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

项目概述

这是一个 Claude Code 中文教程创作项目,向零基础用户系统讲解 Claude Code,让他们能够熟练运用 Claude Code 处理自己的项目。

目录结构:

  • reference/ - 官方参考资料(只读)
    • claude_code帮助文档/ - 英文官方帮助文档(主要参考来源)
      • getting started/ - 基础概念、安装、工作流
      • build with claude code/ - 高级功能:hooks、MCP、子代理、技能等
      • The-Complete-Guide-to-Building-Skill-for-Claude.md - Skill 构建完整指南
    • claude_code使用帮助文档/ - 补充说明文档
  • claude_code使用教程/ - 中文原创教程(主要工作目录)
    • 每篇教程放在独立目录,命名格式:<序号>-<教程名称>/
    • 目录内包含:<教程名称>.md(正文)+ image/(配图)

强制规范

教程选题(强制)

编写教程前,必须先读取 教程目录.md(项目根目录),根据其中的勾选进度确定下一篇待编写的教程。严格按照目录中列出的顺序和标题编写,禁止自行选题或跳过未完成的条目。

教程目录命名(强制)

每篇教程必须放在独立目录中,命名格式:序号-教程文章名称

示例:

claude_code使用教程/
├── 1-Claude Code介绍/
│   ├── Claude Code介绍.md
│   └── image/
├── 2-Claude Code安装指南/
│   ├── Claude Code安装指南.md
│   └── image/

排版规范(强制)

所有文章必须遵守:

  1. 每句话单独成段,段与段之间空一行
  2. 禁止使用 ASCII 方框字符(┌、─、┐、│、└、┘等),目录树结构除外
  3. 重要结论使用 ==**加粗高亮**== 标注

写作参考

  • 文章撰写:详见 .claude/skills/write-tutorial/SKILL.md
    • 包含:选题规划、大纲撰写、内容撰写、深度审查全流程
  • 文章审查:详见 .claude/skills/review-article/SKILL.md
    • 包含:连贯性检查、语言风格、格式规范、深度标准
  • 封面图生成:详见 .claude/skills/cover-generator/SKILL.md
    • 包含:教程封面图自动生成(公众号 21:9 超宽屏格式)
  • 写作风格指南:详见 .claude/reference/style-guide.md
    • 包含:口头禅、语言风格、比喻规范、示例对比(write-tutorial 和 review-article 共用)

子代理(强制调用)

以下三个子代理在教程工作流中必须按顺序调用,不得跳过、省略或用其他方式替代:

  1. reference-searcher(.claude/agents/reference-searcher.md)— 撰写教程前必须调用
    • 必须在动笔之前检索 reference/ 目录中的官方文档,确保教程内容有权威依据
    • 禁止凭记忆或猜测编写教程而不先检索参考文档
  2. prev-article-reader(.claude/agents/prev-article-reader.md)— 撰写教程前必须调用
    • 必须读取上一篇教程内容,确保上下篇概念衔接、风格一致
    • 禁止跳过此步骤直接开始写作(第一篇除外)
  3. review-depth(.claude/agents/review-depth.md)— 教程草稿完成后必须调用
    • 必须对草稿进行"知识可迁移+底层原理+内容详实+框架系统"四维审查
    • 禁止在未经此审查的情况下发布教程

所有子代理均通过 tools 白名单(仅 Read/Glob/Grep)和 disallowedTools 黑名单(禁止 Write/Edit/Bash/Agent/NotebookEdit)双重限制,确保只读不写,防止越权操作。

官方参考

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.