project-structure

Generate PROJECT-STRUCTURE.md with recursive directory trees and dependency analysis.

1|Updated Oct 26, 2020
One-click install
npx skills add https://github.com/jobergner/backent-cli --skill project-structure-jobergner
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-structure
Source: https://github.com/jobergner/backent-cli/tree/main/.claude/skills/project-structure
Command: npx skills add https://github.com/jobergner/backent-cli --skill project-structure-jobergner

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams quickly generate a comprehensive, telegraphic project-structure documentation from the repository. It ensures every directory is documented with meaningful, keyword-dense comments and root files are described succinctly, enabling faster onboarding and audits.

Core Features & Use Cases

  • Recursive tree generation: Build a full directory tree with root files and telegraphic directory comments.
  • Telegraphic comments for directories: Keyword-dense notes capturing purpose, key items, tech patterns, and counts.
  • Dependency analysis (optional): Detect production dependencies and surface them in a dedicated section for quick reference.
  • Use Case: An engineering team wants consistent architecture docs across multiple repos to accelerate reviews and onboarding.

Quick Start

Run the project-structure skill to generate PROJECT-STRUCTURE.md at repo root, then open the file to review telegraphic comments and dependency lists.

Frequently Asked Questions about project-structure

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for my repository's directory structure?

Run the project-structure Skill to automatically generate a PROJECT-STRUCTURE.md file at your repo root. It creates a complete recursive directory tree with telegraphic comments for each directory and root-level files, plus dependency analysis when applicable.

Can I document monorepos and multi-language codebases with a single tool?

Yes. Project-structure handles multi-language codebases and monorepos by generating a full recursive directory tree with inline comments for every directory, capturing purpose, key items, tech patterns, and counts in a single unified document.

What information does the dependency analysis section include?

The Skill conditionally appends a Dependency Analysis section when production dependencies exist in your codebase, surfacing them for quick reference during code reviews and onboarding without manual auditing.

How do telegraphic comments help with code reviews and onboarding?

Telegraphic comments are keyword-dense notes for each directory capturing purpose, tech patterns, and item counts. This enables faster architecture reviews and accelerates team onboarding by providing immediate context without deep exploration.

Does project-structure work with existing git repositories?

Yes. The Skill enforces git-root relative path resolution, meaning it operates from your repository root and documents the full structure relative to that anchor point for consistent, portable documentation across teams.

What output format does the Skill produce?

Project-structure generates PROJECT-STRUCTURE.md—a Markdown file at repo root containing a recursive directory tree with root-level files, inline telegraphic directory comments, and an optional dependency analysis section.