# How to Use Claude Code Skills for Better Python Docstrings

- 发布方：Real Python；作者：Philipp Acsany
- 形式：实践教程 · en
- 原始资源：[https://realpython.com/claude-code-skills/](<https://realpython.com/claude-code-skills/>)
- 本站页面：[https://oplearnx.com/resources/res\_m5xssc5c8jtv](<https://oplearnx.com/resources/res_m5xssc5c8jtv>)
- 学习主题：人工智能 / AI Agent / 工具调用与工作流；人工智能 / AI Agent；计算机科学 / 编程与软件工程
- 内容状态：状态待核验
- 原始发布时间：未知（待核验）
- 本站首次收录：2026-10-22 00:01

## 能学到什么

学习者能在项目中创建一个名为 docstring-doctor 的 Claude Code skill，让 Claude 按固定的 Google 风格规则为 Python 代码给出 docstring 建议。

- 说清 Claude Code skill 的目录结构与 SKILL.md 的 frontmatter（name、description）作用
- 在项目 .claude/skills/ 下创建名为 docstring-doctor 的 skill，并让它的 name 与文件夹名一致
- 编写符合 Google 风格（Args/Returns/Raises）的 Python docstring 规则并写进 SKILL.md
- 在会话开始前先记录 Claude 的默认输出，作为 skill 生效后的对比基线
- 让同一提示在加载 skill 后按固定结构输出 docstring，包括说明 restock\(\) 抛出的 ValueError

## 适合我吗

- 适合：适合已会用 Python 写函数与 docstring、想把 AI 编码助手的行为固化为可复用规则的中级开发者。文章从零构建一个 skill，步骤具体，可跟随操作。
- 需要留意：不适合想系统学习 Python 基础语法的人；教程把内容标注为 intermediate 级别。

## 前置条件与费用

- 知识前置：需要会写 Python 函数、类与 docstring，熟悉终端基本命令和 Markdown 编辑；网页称若你是 Claude Code 新手，可先看 How to Use Claude Code to Write and Debug Python。
- 软件、账号与硬件：已安装并登录 Claude Code（示例在 Claude Code 2.1.273 下核对）；Python 3.12 或更高版本（示例在 Python 3.14.6 下核对）；Linux/WSL 的 Bash 或 macOS 的 zsh/Bash；若 python3 不是启动 Python 的命令，用你自己的命令替代。
- 内容费用：免费：节选可直接读到前置条件、示例模块与第 1 步正文、代码和文件内容，未见正文付费墙；导航栏 “Unlock All Content” 属站点会员入口，不计入本资源费用。
- 实践费用：实践无额外费用：网页写明辅助脚本只使用标准库，无需安装任何东西；练习使用免费的 Python 3.12\+ 即可。
- 转载与修改：按材料分别核对，见本页“来源核验与开课实跑”；仓库许可不自动适用于教材或视频。

## 准备工具

- [Claude Code](<https://code.claude.com/docs/en/quickstart>)：运行 skill、生成 docstring 建议
- [Python 3.12\+](<https://realpython.com/installing-python/>)：运行教程中的示例模块与后续辅助脚本
- 终端（Bash/zsh）：创建目录、启动 claude 会话

## 学习指南

开课检查：提示词由本站整理，尚未按提示词实际完成开课检查。

### 开课提示词（Windows）

```text
请帮我把「How to Use Claude Code Skills for Better Python Docstrings」的学习环境一次准备好，让我之后只需要按顺序学习和做练习。
开始前先问我：课程放在哪个目录（等我给出完整路径），确认我的操作系统和已有工具。确认前不要创建文件或安装软件。

课程入口：https://realpython.com/claude-code-skills/
我的系统：Windows。如果实际不符，先调整方案。
本次路线：Windows：本机动手。只准备这条路线需要的工具；只读路线不安装运行环境、不配置模型密钥。
练习：按教程正文继续练习：重开会话后反复用同一提示对比输出，并阅读 Step 2、Step 3 的正文做后续扩展。
课节（官方顺序）：
1. How to Use Claude Code Skills for Better Python Docstrings：https://realpython.com/claude-code-skills/

1. 环境
- Claude Code 已安装并登录
- Python 3.12 或更高版本
- Bash（Linux/WSL）或 zsh/Bash（macOS）
- 安装前先列出要装的软件和命令，等我同意；已装好的直接复用。
2. 材料
- 官方课程页面：只记录链接 https://realpython.com/claude-code-skills/
3. 目录（最外层放在我确认的位置）
claude-code-skills-docstrings/
├── README.md        # 课程入口、课节清单、每次怎么开始
├── progress.md      # 每课：读讲义 / 做练习 / 记笔记
├── questions.md     # 待解决的问题
├── check-env.ps1     # 环境自检，按 README 操作
├── data/            # 练习用到的样例数据
└── lessons/         # 每课一个文件夹：notes.md + exercises/
    └── 01-01-how-to-use-claude-code/
- 每课文件夹里建 notes.md（顶部写本课官方链接）和 exercises/；课节文件夹名称与上面一致。
- 已有课程目录先检查并复用；不覆盖笔记、作业或 progress.md，不重置已有进度。尚未发布的课节保留入口并注明未发布，不能代写讲义或虚构练习。
4. 自检
- 创建 check-env.ps1，逐项检查并记录“通过/未通过”：
- 在课程根目录运行；每项检查独立执行，进入子目录不能影响下一项。将下面检查转换为 PowerShell 命令，不使用 Bash 语法。
  - ls .claude/skills/docstring-doctor/SKILL.md  → 列出 SKILL.md 路径，说明 skill 文件已建立
  - python3 --version  → 输出 3.12 或更高版本号
  - 在 claude 会话中重复“Suggest docstrings for inventory.py without editing the file.”  → 回答包含 Args/Returns/Raises 小节，且提到 restock() 抛出的 ValueError
- 标注为人工检查、浏览器操作或 notebook 单元的项目，按相应方式操作，不直接粘贴进 shell；脚本只包含当前系统可执行的命令。
- 仅在当前路线需要、对应材料已获准保存、工具已安装时运行该项；需要登录、付费或尚未开放的材料记为“需要我操作/未验证”，不能伪报通过。不执行会调用付费 API、提交作业或修改云服务的检查。
- 运行一次，把结果给我看；未通过的项目说明原因和修复办法。
5. 学习计划
- README.md：课程入口、课节清单（带链接）、每次学习怎么开始（使用“每课提示词”）。
- progress.md：每课三项勾选——读讲义、做练习、记笔记。
6. 最后分三部分汇报：已完成、需要我自己操作的、尚未验证的。

边界：
- 需要管理员权限、会产生费用或需要填写密钥的操作，先告诉我原因，等我同意。密钥由我在本机配置，不发到聊天，不写进笔记或版本库；原项目需要 .env 时确认已被 Git 忽略。
- 不替我写练习或作业答案，也不替我提交。我卡住时只给提示；我明确要求时才给解答。
- 只下载许可允许个人保存的材料；其余只放链接。不把未运行的命令说成成功。
如果你不能直接操作我的文件系统，请在确认目录后给出适用于我的系统、可直接执行的命令和需要保存的文件内容。
```

### 开课提示词（macOS）

```text
请帮我把「How to Use Claude Code Skills for Better Python Docstrings」的学习环境一次准备好，让我之后只需要按顺序学习和做练习。
开始前先问我：课程放在哪个目录（等我给出完整路径），确认我的操作系统和已有工具。确认前不要创建文件或安装软件。

课程入口：https://realpython.com/claude-code-skills/
我的系统：macOS。如果实际不符，先调整方案。
本次路线：macOS：本机动手。只准备这条路线需要的工具；只读路线不安装运行环境、不配置模型密钥。
练习：按教程正文继续练习：重开会话后反复用同一提示对比输出，并阅读 Step 2、Step 3 的正文做后续扩展。
课节（官方顺序）：
1. How to Use Claude Code Skills for Better Python Docstrings：https://realpython.com/claude-code-skills/

1. 环境
- Claude Code 已安装并登录
- Python 3.12 或更高版本
- Bash（Linux/WSL）或 zsh/Bash（macOS）
- 安装前先列出要装的软件和命令，等我同意；已装好的直接复用。
2. 材料
- 官方课程页面：只记录链接 https://realpython.com/claude-code-skills/
3. 目录（最外层放在我确认的位置）
claude-code-skills-docstrings/
├── README.md        # 课程入口、课节清单、每次怎么开始
├── progress.md      # 每课：读讲义 / 做练习 / 记笔记
├── questions.md     # 待解决的问题
├── check-env.sh     # 环境自检，按 README 操作
├── data/            # 练习用到的样例数据
└── lessons/         # 每课一个文件夹：notes.md + exercises/
    └── 01-01-how-to-use-claude-code/
- 每课文件夹里建 notes.md（顶部写本课官方链接）和 exercises/；课节文件夹名称与上面一致。
- 已有课程目录先检查并复用；不覆盖笔记、作业或 progress.md，不重置已有进度。尚未发布的课节保留入口并注明未发布，不能代写讲义或虚构练习。
4. 自检
- 创建 check-env.sh，逐项检查并记录“通过/未通过”：
- 在课程根目录运行；每项检查独立执行，进入子目录不能影响下一项。使用当前系统的终端运行。
  - ls .claude/skills/docstring-doctor/SKILL.md  → 列出 SKILL.md 路径，说明 skill 文件已建立
  - python3 --version  → 输出 3.12 或更高版本号
  - 在 claude 会话中重复“Suggest docstrings for inventory.py without editing the file.”  → 回答包含 Args/Returns/Raises 小节，且提到 restock() 抛出的 ValueError
- 标注为人工检查、浏览器操作或 notebook 单元的项目，按相应方式操作，不直接粘贴进 shell；脚本只包含当前系统可执行的命令。
- 仅在当前路线需要、对应材料已获准保存、工具已安装时运行该项；需要登录、付费或尚未开放的材料记为“需要我操作/未验证”，不能伪报通过。不执行会调用付费 API、提交作业或修改云服务的检查。
- 运行一次，把结果给我看；未通过的项目说明原因和修复办法。
5. 学习计划
- README.md：课程入口、课节清单（带链接）、每次学习怎么开始（使用“每课提示词”）。
- progress.md：每课三项勾选——读讲义、做练习、记笔记。
6. 最后分三部分汇报：已完成、需要我自己操作的、尚未验证的。

边界：
- 需要管理员权限、会产生费用或需要填写密钥的操作，先告诉我原因，等我同意。密钥由我在本机配置，不发到聊天，不写进笔记或版本库；原项目需要 .env 时确认已被 Git 忽略。
- 不替我写练习或作业答案，也不替我提交。我卡住时只给提示；我明确要求时才给解答。
- 只下载许可允许个人保存的材料；其余只放链接。不把未运行的命令说成成功。
如果你不能直接操作我的文件系统，请在确认目录后给出适用于我的系统、可直接执行的命令和需要保存的文件内容。
```

### 开课提示词（Linux）

```text
请帮我把「How to Use Claude Code Skills for Better Python Docstrings」的学习环境一次准备好，让我之后只需要按顺序学习和做练习。
开始前先问我：课程放在哪个目录（等我给出完整路径），确认我的操作系统和已有工具。确认前不要创建文件或安装软件。

课程入口：https://realpython.com/claude-code-skills/
我的系统：Linux。如果实际不符，先调整方案。
本次路线：Linux：本机动手。只准备这条路线需要的工具；只读路线不安装运行环境、不配置模型密钥。
练习：按教程正文继续练习：重开会话后反复用同一提示对比输出，并阅读 Step 2、Step 3 的正文做后续扩展。
课节（官方顺序）：
1. How to Use Claude Code Skills for Better Python Docstrings：https://realpython.com/claude-code-skills/

1. 环境
- Claude Code 已安装并登录
- Python 3.12 或更高版本
- Bash（Linux/WSL）或 zsh/Bash（macOS）
- 安装前先列出要装的软件和命令，等我同意；已装好的直接复用。
2. 材料
- 官方课程页面：只记录链接 https://realpython.com/claude-code-skills/
3. 目录（最外层放在我确认的位置）
claude-code-skills-docstrings/
├── README.md        # 课程入口、课节清单、每次怎么开始
├── progress.md      # 每课：读讲义 / 做练习 / 记笔记
├── questions.md     # 待解决的问题
├── check-env.sh     # 环境自检，按 README 操作
├── data/            # 练习用到的样例数据
└── lessons/         # 每课一个文件夹：notes.md + exercises/
    └── 01-01-how-to-use-claude-code/
- 每课文件夹里建 notes.md（顶部写本课官方链接）和 exercises/；课节文件夹名称与上面一致。
- 已有课程目录先检查并复用；不覆盖笔记、作业或 progress.md，不重置已有进度。尚未发布的课节保留入口并注明未发布，不能代写讲义或虚构练习。
4. 自检
- 创建 check-env.sh，逐项检查并记录“通过/未通过”：
- 在课程根目录运行；每项检查独立执行，进入子目录不能影响下一项。使用当前系统的终端运行。
  - ls .claude/skills/docstring-doctor/SKILL.md  → 列出 SKILL.md 路径，说明 skill 文件已建立
  - python3 --version  → 输出 3.12 或更高版本号
  - 在 claude 会话中重复“Suggest docstrings for inventory.py without editing the file.”  → 回答包含 Args/Returns/Raises 小节，且提到 restock() 抛出的 ValueError
- 标注为人工检查、浏览器操作或 notebook 单元的项目，按相应方式操作，不直接粘贴进 shell；脚本只包含当前系统可执行的命令。
- 仅在当前路线需要、对应材料已获准保存、工具已安装时运行该项；需要登录、付费或尚未开放的材料记为“需要我操作/未验证”，不能伪报通过。不执行会调用付费 API、提交作业或修改云服务的检查。
- 运行一次，把结果给我看；未通过的项目说明原因和修复办法。
5. 学习计划
- README.md：课程入口、课节清单（带链接）、每次学习怎么开始（使用“每课提示词”）。
- progress.md：每课三项勾选——读讲义、做练习、记笔记。
6. 最后分三部分汇报：已完成、需要我自己操作的、尚未验证的。

边界：
- 需要管理员权限、会产生费用或需要填写密钥的操作，先告诉我原因，等我同意。密钥由我在本机配置，不发到聊天，不写进笔记或版本库；原项目需要 .env 时确认已被 Git 忽略。
- 不替我写练习或作业答案，也不替我提交。我卡住时只给提示；我明确要求时才给解答。
- 只下载许可允许个人保存的材料；其余只放链接。不把未运行的命令说成成功。
如果你不能直接操作我的文件系统，请在确认目录后给出适用于我的系统、可直接执行的命令和需要保存的文件内容。
```

### 每课提示词

```text
继续学习「How to Use Claude Code Skills for Better Python Docstrings」。课程目录是 claude-code-skills-docstrings/（不知道完整路径就先问我）。
1. 读 progress.md，找到下一课；如果我指定了第几课，就准备那一课。
2. 打开这一课的官方页面和本地讲义，列出本课练习要用的工具、文件和样例数据。缺少的先告诉我，等我同意再安装或下载。
3. 在 lessons/ 对应的课节文件夹里准备好练习：exercises/ 里给每道题建一个文件，写上题号和题目原文链接，不写答案；已有文件保留，样例数据放到 data/。拿不到官方题目或起始代码时记录限制，不编造替代品。
4. 按 README 运行开课时生成的自检脚本或在线检查清单，并检查本课新增工具能否正常使用。
5. 告诉我：本课先读哪几节、从哪道练习开始、大约需要多久。我学完后，帮我在 progress.md 勾选并把问题整理到 questions.md。

边界：
- 需要管理员权限、会产生费用或需要填写密钥的操作，先告诉我原因，等我同意。密钥由我在本机配置，不发到聊天，不写进笔记或版本库；原项目需要 .env 时确认已被 Git 忽略。
- 不替我写练习或作业答案，也不替我提交。我卡住时只给提示；我明确要求时才给解答。
- 只下载许可允许个人保存的材料；其余只放链接。不把未运行的命令说成成功。
```

### 课节（官方顺序）

1. [How to Use Claude Code Skills for Better Python Docstrings](<https://realpython.com/claude-code-skills/>)

## 指南参考

- [课程主页](<https://realpython.com/claude-code-skills/>)

## 来源、许可与验证记录

- **开课提示词未完整验证，需要自备账号或资源**：Claude Code（需安装并登录）用于练习构建与调用 skill；Python 3.12 或更高版本，用于后续的辅助脚本
- 转载与修改 · 课程页面与材料：未找到明确许可。节选未出现本站文章的具体许可声明 [依据](<https://realpython.com/claude-code-skills/>)
- 链接检查：1/1 个可以访问

## 来源与推荐

- 编辑整理收录

---
来源：LearnMap · 学径（https://oplearnx.com）