bootstrap

分类: 开发与编程 | 上传者: ElhanM | 下载: 0 | 版本: v1.0（最新）

Document a codebase from scratch by reading its structure and creating docs/ files

更新日志: Source: GitHub https://github.com/ElhanM/saas-vibe

目录结构

当前层级: .claude/skills/bootstrap/

📄 SKILL.md 2.2 KB

SKILL.md

---
name: bootstrap
description: Document a codebase from scratch by reading its structure and creating docs/ files
disable-model-invocation: true
---

Document this codebase from scratch. Follow these steps exactly:

1. **Read the project manifest:**
   Look for and read whichever exists: `package.json`, `pyproject.toml`, `Cargo.toml`, `go.mod`, or equivalent.
   For monorepos, also read per-package manifests (e.g., `apps/*/package.json`).

2. **Read the README** (if it exists).

3. **Identify entry points:**
   Look for `main.*`, `index.*`, `app.*`, `server.*`, or whatever the manifest points to as the start of execution.

4. **Scan the folder structure:**
   Get a high-level sense of how the project is organized. Do not read every file — just enough to understand the shape.

5. **Ask before writing:**
   If the structure is unclear or ambiguous, ask one focused question before proceeding. Do not guess.

6. **Create docs in `docs/`:**
   Group docs by logical area (e.g., `docs/auth/`, `docs/payments/`, `docs/data-pipeline/`). Subfolders can contain subfolders if needed. Groupings should reflect what the codebase does, not how the folders are named — folder paths change, docs shouldn't have to.

   For each area, add:
   - `overview.md` — what it does, tech stack, key entry points
   - `architecture.md` — folder structure, key modules, data flow
   - One additional doc per major feature area (e.g., `auth.md`, `payments.md`)

   Cross-cutting docs (conventions, patterns, shared rules) go in `docs/conventions/`.

   Keep every doc to 5–10 lines max.

7. **Update `docs/README.md`:**
   Add an entry for every doc created, grouped by subfolder, using the format: `- \`filename.md\` — one-line description`.

8. **Extract Claude memory:**
   Check `~/.claude/projects/` for any memory files related to this project. If found, extract anything still relevant into the appropriate `docs/` subfolder (e.g., `docs/conventions/`, `docs/auth/`) — not a separate memory folder.

9. **Report when done:**
   List every file created with a one-sentence description of what it covers.

**Doc format guidelines:**
- No intros or preamble — start with the content
- 5–10 lines max per file
- Patterns and gotchas, not exhaustive details
- Self-describing filenames only

登录后下载/点赞/收藏 ❤ 4 | ★ 0

bootstrap

目录结构

SKILL.md

举报内容

提示