Canonical: https://botbento.com/zh/usecases/codebase-documentation/
Format: Markdown representation of the public HTML page.

[首页](/) / [用例](/zh/usecases/) / [编程](/zh/usecases/?category=coding)

编程 · 中级

已验证

自动化验证

- 已通过全部自动化关卡：结构校验、唯一性、HTTPS 与来源链接可访问、提示注入与安全扫描、审批步骤规则。
- 未记录起草模型。
- 第二模型审核：deepseek-v4-pro（无严重或高危问题）。
- 简体中文译文：google/gemini-4-argon，由 openai/gpt-5.5 审核。
- 验证于 2026-10-16。
- 仅经自动化检查和 AI 审核，未经人工审核。[验证如何运作](/zh/usecases/verification/)

# 为现有代码库起草文档

为新贡献者提供的代码仓库入门指南。

[在 BotBento 中使用 ](https://app.botbento.com/?ref=usecases&utm_source=botbento.com&utm_medium=usecases&utm_campaign=codebase-documentation)复制提示词分享[Markdown](/text/zh/usecases/codebase-documentation/index.md)[English](/usecases/codebase-documentation/)

打开 BotBento。请将提示词粘贴到 Bot 中；不含任何预设配置。

- 你提问时触发你指定代码仓库
- 然后读取文件夹与模块
- 结果每个区域生成一段说明

让 Bot 遍历代码仓库，并为每个文件夹和主模块起草简短说明，为新贡献者提供入门指南。

## 起步提示词

BotBento推荐

```
读取代码仓库，为每个顶层文件夹和主模块撰写一段简短说明：它的作用以及从哪里开始。标记出任何你通过推断而非直接读取得到的内容。
```

复制Muse Code配置示意

```
Run muse in the project directory, then ask: Read the repository and write one short paragraph per top-level folder and main module: what it does and where to start. Mark anything you inferred rather than read.
```

复制

Muse Code is Meta's terminal and CI coding agent; its docs describe planning, editing and running commands with approvals. [文档 ](https://dev.meta.ai/docs/muse-code)

## 所用工具

GitHub文档

## 适用于

BotBentoMuse Code

## 标签

- documentation
- codebase
- onboarding

## 来源

[Autodoc: Toolkit for auto-generating codebase documentation using LLMs](https://news.ycombinator.com/item?id=35297766)
Hacker News · 已核查 2026-10-14

内容以我们自己的话概述。其中描述的任何结果均为原作者所述，并非 BotBento 实测。

由 AI 辅助自英文版翻译，并经自动审核模型检查。以英文文本为准。

作者：BotBento Editorial · 发布于 2026-10-14 · 更新于 2026-10-14 · [提交更正](/contact/)

## 相关用例

-

编程中级

## [保持代码库文件映射与架构文档同步](/zh/usecases/keeping-repository-file-maps-and-architecture-docs/)

比对文档审查代码库文件层级，检测缺失或过期的描述

GitHub终端文档[已验证](/zh/usecases/verification/)
-

编程中级

## [对照源代码审计代码库文档](/zh/usecases/auditing-repository-documentation-against-source-code/)

扫描代码库以发现过时的文档示例、验证 API 行为并起草准确的文档

GitHub终端文档[已验证](/zh/usecases/verification/)
-

编程中级

## [根据 GitHub 变更自动更新文档](/zh/usecases/automated-documentation-updates-from-github-changes/)

使使用指南和 API 文档与代码修改及问题保持同步

GitHub文档[已验证](/zh/usecases/verification/)