使用 Claude Code 撰写技术文档并配图的基础教程

使用 Claude Code 撰写技术文档并配图的基础教程

  • 前置学习教程claude code
  • 前置学习教程agent skills
  • skills工具链接
  • Claude Code安装教程

01-scene-cover.png

本教程面向熟悉命令行和基本开发工具的开发者,介绍如何利用 Claude Code 高效撰写技术文档,并使用 技能为文章智能配图。

确保你已经:

  • 安装并配置好 Claude Code CLI
  • 拥有可用的 API 密钥
  • 具备以下技能:
    • (文章配图技能)
    • (底层图片生成能力,被 article-illustrator 调用)

02-framework-toolchain.png

  • baoyu-article-illustrator:分析文章结构,识别需要配图的位置,决定图片类型和风格
  • baoyu-image-gen:执行实际的图片生成任务

1.1 基本工作流程

Claude Code 写文档的核心优势在于它能够:

  • 直接读取代码库理解上下文
  • 根据代码自动生成准确的文档
  • 保持文档与代码的一致性

启动方式:


1.2 常用文档撰写命令示例

为代码生成文档

创建项目 README

撰写教程类文档

1.3 提升文档质量的技巧

技巧 说明 提供上下文 告诉 Claude 目标读者是谁、技术水平如何 明确结构 预先说明你希望的文档结构(章节、格式) 迭代修改 生成后可以针对具体段落要求修改 结合代码 让 Claude 先读取相关代码再写文档

2.1 技能简介

是一个智能文章配图技能,核心能力:

  • 自动分析文章结构:识别标题、段落、关键概念
  • 智能识别配图位置:判断哪些地方需要视觉辅助
  • Type × Style 二维配图法:根据内容类型和期望风格生成最合适的图片
  • 调用底层 baoyu-image-gen:实际图片生成由底层能力完成

2.2 基本使用方法

方式一:一键为文章配图(推荐)

或者用自然语言:


方式二:指定文章路径

2.3 Type × Style 二维配图法

03-framework-type-style.png

这是 的核心方法论:

维度 说明 示例
Type(类型) 图片要表达什么 概念图、流程图、场景图、对比图
Style(风格) 视觉呈现方式 扁平插画、3D渲染、手绘风、科技感

组合示例(以本教程为例):

文章内容 Type Style 配图效果 工具链关系 架构图 扁平插画 展示两个工具的调用关系 Type × Style 方法 概念图 信息图表 二维矩阵示意图 完整工作流 流程图 科技感 写作→配图→迭代的流程

2.4 文档配图的完整工作流(以本教程为例)

04-flowchart-workflow.pngclaude code 教程


3.1 完整对话示例

以下是创作本教程的实际对话流程:


3.2 配图类型参考

文章类型 推荐 Type 推荐 Style 技术教程 流程图、步骤图 扁平插画、信息图表 概念解释 概念图、类比图 简洁图示、手绘风 产品介绍 场景图、功能图 3D渲染、产品风 最佳实践 对比图、清单图 专业商务、简约风

3.3 过程图示

  • 输入文章要求

ab905d8016bf3f521a57ac7c9eec8c63.png

  • 开始规划配图

3b465947e002f580173b409e425da548.png

  • 文生图国产模型配置

注意原始的工具是不支持国产模型【默认支持OPENAI及GOOGLE的文生图模型】,这里我做了改造,增加了阿里云的【通义-文生图-Z-Image,单模型白嫖额度100张图片,如下图,还有其他模型,可以修改环境变量调整【~/.baoyu-skills/.env中增加DASHSCOPE_IMAGE_MODEL=z-image-turbo】】支持改造后代码【分支 my-baoyu-skills】 注意PR已合并,直接安装最新版即可。

image.png

  1. 替换生图技能【baoyu-image-gen】中的文件内容【这里也可以手动直接安装我fork过来的版本,修改内容已提交】 image.png image.png
  2. 新增阿里云模型配置apikey 创建用户环境变量

增加apikey配置【在~/.baoyu-skills】目录下创建.env文件内容如下【对应的api key从阿里云百炼平台获取】:


  1. 图片prompt生成

baoyu-article-illustrator会根据文章内容进行分析然后生成插图规划,然后根据规划生成对应的文生图prompt 5. prompt生成后会调用baoyu-image-gen按照规划的图片prompt进行图片生成

4e0c9afab11d9c2cba2ee7abc8ea2c00.png 6. 生产完成后会将图片插入预定的位置

dd3e992868d2f5c47be3fa012871a77e.png

  1. 注意:有时候会未自动插入,干预提示一下即可,也可根据文件目录下的outline.md文件内容进行手动粘贴

image.png 8. 效果截图

image.png

Q: baoyu-article-illustrator 和 baoyu-image-gen 有什么区别?

A: 是面向用户的智能配图技能,会分析文章并决定在哪里配什么图; 是底层的图片生成能力,被前者调用来实际生成图片。一般情况下,直接使用 即可。

Q: 生成的图片保存在哪里?

A: 默认保存在当前工作目录或文章所在目录。

Q: 可以只为文章的某一部分配图吗?

A: 可以,在调用时指定具体位置,如:”只为’工具链关系’这一节配图”。

Q: 如何修改已生成的图片风格?

A: 直接描述你的修改需求,如:”把封面图换成 3D 风格”,Claude 会重新生成并替换。

Q: 支持哪些图片风格?

A: 支持扁平插画、3D渲染、手绘风、科技感、简约风、信息图表等多种风格,可根据文章调性自由选择。

Claude Code + baoyu-article-illustrator 的组合让技术文档创作变得高效:

  1. 写作阶段:利用 Claude 对代码的理解能力,生成准确的技术文档
  2. 配图阶段:一条命令智能分析 + 自动配图,无需手动指定每张图
  3. 迭代优化:在对话中持续调整,直到满意为止

工具链优势:

  • 负责”思考”:分析文章、决定配图策略
  • 负责”执行”:生成高质量图片

掌握这套工作流,可以大幅提升技术文档的创作效率和视觉质量。

更多工具请参考源


版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/238226.html原文链接:https://javaforall.net

(0)
上一篇 2026年3月16日 上午10:44
下一篇 2026年3月16日 上午10:44


相关推荐

关注全栈程序员社区公众号