使用claude code可自动化生成规范readme.md：一、/init生成claude.md；二、generate-readme构建文档；三、skills_repos集成团队模板；四、--from-code-only反向推导；五、claude-docs.json定制输出。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果您在初始化项目后需要一份结构清晰、内容准确且符合团队或行业规范的 README.md，但手动编写耗时易错，则可能是由于缺乏自动化文档生成机制。以下是实现此目标的具体操作路径：
一、使用 Claude Code 的 /init 命令生成初始 CLAUDE.md
CLAUDE.md 是 Claude Code 识别项目上下文并生成规范化文档的基础配置文件。该文件一旦存在，Claude Code 即可据此理解项目类型、技术栈与结构特征，为后续 README 生成提供语义依据。
1、在项目根目录下启动 Claude Code CLI 工具。
2、在交互式终端中输入 /init 命令并回车。
3、Claude Code 将自动扫描当前目录中的 package.json、pyproject.toml、.gitignore、src/ 等关键元素，分析语言类型与项目规模。
4、系统生成一份带注释的 CLAUDE.md，其中已预填项目名称、描述、安装步骤、运行方式等基础区块。
二、执行 generate-readme 命令触发 README 自动构建
在 CLAUDE.md 存在且内容完整的基础上，Claude Code 可调用内置文档生成引擎，结合代码分析结果与模板规则，输出语义一致、格式合规的 README.md。
1、确保项目中已存在 CLAUDE.md 文件，并确认其包含至少 title、description、tech-stack 三项元信息。
2、在 Claude Code 终端中输入 generate-readme 命令。
3、工具将递归解析 src/、lib/、examples/ 等目录，提取导出函数签名、CLI 参数、环境变量说明等内容。
4、自动生成的 README.md 将包含：项目概览、快速开始、技术栈图标、API 使用示例、贡献指南、许可证声明等标准章节。
三、通过 skills_repos 集成团队级 README 模板
当多个项目需遵循统一排版风格、章节顺序或合规要求（如 GDPR 声明、安全策略链接）时，可将标准化模板托管至 Git 仓库，并通过 skills_repos 机制注入 Claude Code 运行时环境。
1、创建一个名为 readme-templates 的私有 Git 仓库，在其中存放 team-readme-template.md 和 section-security.md 等模块化片段。
统一LLM网关 - 一个API对接70+AI模型，使用单一API密钥即可调用GPT、Claude、Gemini、Qwen、Deepseek、Grok等主流模型。
2、在本地 ~/.claude/config.json 中添加："skills_repos": ["https://git.example.com/team/readme-templates"]。
3、运行 claude-code --reload-skills 强制刷新技能缓存。
4、再次执行 generate-readme 时，系统将优先采用远程仓库中定义的标题层级、图标渲染逻辑与法律条款插入点。
四、基于现有代码反向推导 README 内容
对于已有历史代码但缺失文档的项目，Claude Code 支持不依赖 CLAUDE.md 的“无感生成”模式，直接从源码语义中提取关键信息，规避人工补全配置的成本。
1、进入含 main.py 或 index.js 的项目根目录，启动 Claude Code CLI。
2、输入指令：generate-readme --from-code-only。
3、工具将静态分析入口文件的 import 语句、函数 docstring、CLI 参数定义（如 argparse 或 commander）、HTTP 路由注册等结构。
4、输出的 README.md 中，“Usage”部分将精确映射实际命令行参数，“API Reference”将列出所有 @api 注解或 OpenAPI-style JSDoc 方法。
五、通过 claude-docs.json 配置定制化输出行为
若需控制 README 的渲染粒度（例如隐藏内部工具函数、强制包含 CI 状态徽章、跳过贡献者列表），可通过本地配置文件声明生成策略，实现细粒度干预。
1、在项目根目录新建 claude-docs.json 文件。
2、写入如下内容：{"exclude_patterns": ["internal/", "test_.*"], "include_badges": true, "section_order": ["overview", "install", "usage", "api", "license"]}。
3、保存后执行 generate-readme --config claude-docs.json。
4、生成结果将严格按指定顺序组织章节，过滤掉匹配 exclude_patterns 的代码路径，并在顶部插入 GitHub Actions 与 npm version 徽章。
