14.2 前端开发提示词

14.5 文档与报告提示

文档是优秀代码与卓越团队之间的桥梁。Claude Code 擅长将原始逻辑、零散注释和未经整理的代码仓库转化为简洁、一致且专业的文档。无论你需要内联代码注释、API 参考页面、更新日志，还是基于 Markdown 的完整开发者指南，精心设计的提示词都能让 Claude 自动生成结构清晰、可读性强且准确的文档。

本节探讨的文档与报告提示词，能够引导 Claude 像资深技术文档工程师一样工作——精确、具备上下文感知能力，并保持风格一致。目标是让文档生成与编码本身一样不可或缺、一样自动化，确保每个项目都保持透明、可维护，且易于新手上手。

概念开发

当 Claude 被赋予清晰的角色、结构和目标时，它在文档编写方面最为高效。与静态文档生成器不同，如果你能在提示词中明确指引，Claude 能够推断关系、改写以提升清晰度，并合理组织主题。关键在于定义：

• 文档格式—— Markdown、reStructuredText 或纯文本。
• 语气与深度—— 面向内部开发者、开源用户还是管理层。
• 结构—— 例如：概述 → 安装 → 使用 → 示例 → 注意事项。
• 数据来源—— 需要总结的代码片段、API 路由或测试结果。
• 期望产出—— 可读文件、文档字符串或自动生成的 README 章节。

Claude 基于推理的方式使其非常适合生成能够随代码库一同演进的"活文档"。

动手示例 1：生成 Markdown API 文档

提示词：

你是一位资深技术文档工程师。

为这个 FastAPI 应用生成完整的 Markdown 文档，包括：

• 概述

• 端点说明

• 请求与响应示例

• 错误处理说明

输出必须整洁，可直接发布到 README.md 文件中。

from fastapi import FastAPI

app = FastAPI()

@app.get("/hello")
def say_hello(name: str):
    return {"message": f"Hello, {name}!"}

@app.post("/sum")
def calculate_sum(numbers: list[int]):
    return {"total": sum(numbers)}

Claude 输出（示例）：