github/awesome-copilot✦ 精选0°

acquire-codebase-knowledge

仓库创建 2025年6月12日最近提交 5 小时前SkillHot 收录 20 天前

⬈ GitHub 仓库 ⬈ SKILL.md 原文件 ⬇ Raw 原始文件

▸ 精选理由

自动化生成关键文档，显著减少人工摸索成本。

这个 Skill 做什么

为现有代码库生成可验证的全面文档集以便入职与维护。

把一个现有代码库彻底摸清并生成一套可验证、上手即用的文档，方便新人入职和后续维护。你想要把仓库做成可查证的知识集、画清架构脉络或生成维护手册时就用。特别强调只记录能从源码或终端输出来验证的事实，不凭猜测，保证文档真实可信且可复现。

▸ 展开 SKILL.md 英文原文

Use this skill when the user explicitly asks to map, document, or onboard into an existing codebase. Trigger for prompts like "map this codebase", "document this architecture", "onboard me to this repo", or "create codebase docs". Do not trigger for routine feature implementation, bug fixes, or narrow code edits unless the user asks for repository-level discovery.

开发编程代码库地图文档生成入职通用

3.7w

Stars

4.6k

Forks

仓库内 Skill

+837

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/github/awesome-copilot/main/skills/acquire-codebase-knowledge/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/github/awesome-copilot/main/skills/acquire-codebase-knowledge/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# Acquire Codebase Knowledge

Produces seven populated documents in `docs/codebase/` covering everything needed to work effectively on the project. Only document what is verifiable from files or terminal output — never infer or assume.

## Output Contract (Required)

Before finishing, all of the following must be true:

1. Exactly these files exist in `docs/codebase/`: `STACK.md`, `STRUCTURE.md`, `ARCHITECTURE.md`, `CONVENTIONS.md`, `INTEGRATIONS.md`, `TESTING.md`, `CONCERNS.md`.
2. Every claim is traceable to source files, config, or terminal output.
3. Unknowns are marked as `[TODO]`; intent-dependent decisions are marked `[ASK USER]`.
4. Every document includes a short "evidence" list wit

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有