Files
awesome-copilot/skills/acquire-codebase-knowledge/assets/templates/STRUCTURE.md
Satya K b8f3822748 Adds a new Agent Skill - Acquire-Codebase-Knowledge (#1373)
* feat(skill): add acquire-codebase-knowledge skill documentation

* feat(templates): add architecture, concerns, conventions, integrations, stack, structure, and testing documentation templates

* feat(references): add inquiry checkpoints and stack detection documentation

* feat(scan): add script to collect project discovery information for acquire-codebase-knowledge skill

* feat(skills): add acquire-codebase-knowledge skill for codebase mapping and documentation

* feat(scan): enhance scan script with absolute path handling and improved output variable validation

* feat(scan): replace bash script with Python script for project discovery information collection

* feat(skills): update acquire-codebase-knowledge skill to replace scan.sh with scan.py
2026-04-14 10:29:57 +10:00

1.1 KiB

Codebase Structure

Core Sections (Required)

1) Top-Level Map

List only meaningful top-level directories and files.

Path Purpose Evidence
[path/] [purpose] [source]

2) Entry Points

  • Main runtime entry: [FILE]
  • Secondary entry points (worker/cli/jobs): [FILES or NONE]
  • How entry is selected (script/config): [NOTE]

3) Module Boundaries

Boundary What belongs here What must not be here
[module/layer] [responsibility] [forbidden logic]

4) Naming and Organization Rules

  • File naming pattern: [kebab/camel/Pascal + examples]
  • Directory organization pattern: [feature/layer/domain]
  • Import aliasing or path conventions: [RULE]

5) Evidence

  • [path/to/root-tree-source]
  • [path/to/entry-config]
  • [path/to/key-module]

Extended Sections (Optional)

Add only when repository complexity requires it:

  • Subdirectory deep maps by feature/layer
  • Middleware/boot order details
  • Generated-vs-source layout boundaries
  • Monorepo workspace-level structure maps