project-analyzer
Skill87 starsChanged 6 months agoApache-2.0View on GitHub
Generate a comprehensive project documentation (whitepaper) based on deep codebase analysis, covering architecture, modules, testing, and deployment.
8 other projects use a version of this.
Adopted by
Most recently taken up by
- Hainrixz/agente-pagokittheir own version, first seen Nov 1, 2026
- maroffo/claude-forgetheir own version, first seen Oct 25, 2026
- 10CG/aria-plugintheir own version, first seen Oct 20, 2026
- fatih-developer/fth-skillstheir own version, first seen Oct 13, 2026
- ZeroTokenClaw/agents-skillstheir own version, first seen Sep 21, 2026
- chipoto69/claude-skillstheir own version, first seen Jan 19, 2026
Other versions8 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 8
- Hainrixz/agente-pagokit★ 68same name
- maroffo/claude-forge★ 17same name
- GrishaAngelovGH/gemini-cli-agent-skills★ 16same name
- fatih-developer/fth-skills★ 7same name
- mevans2120/project-suite-claude-skills★ 4same name
- chipoto69/claude-skills★ 2same name
- 10CG/aria-plugin★ 1same name
- ZeroTokenClaw/agents-skills★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository21 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- agent-skill-reviewerSkill
- code-readerSkill
- dir-organizerSkill
- doc-reviewerSkill
- drawio-designerSkill
- editorial-card-designerSkill
- humanizer-zhSkill
- md-link-checkerSkill
- md-summarizerSkill
- md-translatorSkill
- ontologySkill
- openspec-assistantSkill
- pptx-editorSkill
- pptx-readerSkill
- reference-organizerSkill
- self-reviewSkill
- tech-outline-plannerSkill
- update-submitterSkill
- web-content-downloaderSkill
The file
We split this skill into the rules it gives an agent
3 rules. 0 are common, 2 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 5 edited versions we read keep these.
2
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 61
Input: All identified Infra Files (e.g., Makefile, Dockerfile, .github/workflows/, pom.json).
- Distinctive: line 94
Read-Only Source: Never modify the source repository.
- Distinctive: line 95
Content Weighting: Ensure the Chief Architect strictly adheres to the 60/40 ratio between Architecture/Modules and Engineering Practices.
“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Deep Project Analysis
This skill extends the core mechanics of code-reader to systematically analyze an entire repository and synthesize a comprehensive "Project Whitepaper". It combines deep module-level understanding with high-level architectural synthesis and engineering practices (build, test, deploy).
The final output focuses heavily on Architecture & Module Deep Dives (approx. 60%), supported by practical Engineering & Operations guides.
1. The Team Roles
This workflow employs specialized agents to gather distinct types of information before synthesizing the final document:
- Agent A (Tech Writer): The module expert. This role is directly fulfilled by invoking the
code-readerskill. It reads source code to extract module-level capabilities, data structures, and state flows, ensuring high accuracy through its built-in ABC verification loop. - Agent B (DevOps Engineer): The infrastructure expert. Scans configuration files (Makefiles, Dockerfiles, CI/CD pipelines,
package.json, etc.) to extract build, test, and deployment practices. - Agent C (Chief Architect): The synthesizer. Reads all outputs from the
code-readermodule skills and the DevOps Engineer to author the final Comprehensive Project Documentation, ensuring a coherent narrative and architectural accuracy.
REQUIRED SUB-SKILL: You MUST use the code-reader skill as the engine for Phase 2.
2. Usage
/project-analyzer <source> <output-dir>- source: local path (e.g.,
./path/to/repo) or GitHub URL - output-dir: where the final whitepaper and intermediate analysis files are written
3. Full Flow
You MUST follow these phases in order to generate the final documentation.
3.1 Phase 1: Prepare & Scan
This initial phase handles the resolution and preparation of the target source codebase.
- Resolve the target repository (clone if URL, verify if local).
- Scan the directory structure to identify:
- Code Modules: Directories containing core business logic (
src/,lib/, etc.). - Infra Files: Build scripts, Dockerfiles, CI/CD workflows, config files.
- Code Modules: Directories containing core business logic (
- Generate an initial dependency graph between modules.
3.2 Phase 2: Deep Module Reading (via code-reader)
This phase delegates the heavy lifting of code comprehension to the code-reader skill.
For each identified core module, invoke the code-reader skill targeting that specific module directory.
- The
code-readerskill will run its Tech Writer -> QA Engineer -> Junior Dev verification loop. - Collect the generated, fully-verified
SKILL.mdfiles for each module. Note: This phase focuses purely on code, logic, and data structures.
3.3 Phase 3: Infrastructure Analysis (DevOps Engineer)
This phase extracts engineering practices from configuration files.
Dispatch the DevOps Engineer agent (using references/devops-engineer-prompt.md).
- Input: All identified Infra Files (e.g.,
Makefile,Dockerfile,.github/workflows/,pom.json). - Output: A structured report covering Build Steps, Testing Strategies, and Deployment Topologies.
3.4 Phase 4: Architectural Synthesis (Chief Architect)
This phase generates the final Comprehensive Project Documentation.
Dispatch the Chief Architect agent by reading and strictly following references/chief-architect-prompt.md.
- Input: The module documents generated in Phase 2, the infrastructure report from Phase 3, and the initial directory scan.
- Project Name: You MUST extract the actual project name (e.g., from the repository directory name,
package.json, orgo.mod) and use it to replace all{project-name}placeholders in the output filename. - Instruction constraints:
- The Architect MUST allocate approximately 60% of the document's depth and length to System Architecture and Core Modules, and the remaining 40% to Project Overview, Scenarios, and Engineering Practices.
- Diagrams: You MUST output Mermaid syntax for architecture diagrams, flowcharts, and sequence diagrams as explicitly required in the Chief Architect prompt.
- Output:
<actual-project-name>-deep-dive.mdwritten to the<output-dir>. The document MUST follow this exact 7-chapter outline:- 项目全局摘要 (Project Executive Summary)
- 系统架构分析 (System Architecture Analysis)
- 核心模块代码深度解析 (Core Modules Deep Dive)
- 核心功能执行流程分析 (Core Function Execution Flow)
- 质量与性能评估 (Quality & Performance Assessment)
- 项目构建与部署 (Project Build & Deployment)
- 二次开发指南 (Extension & Contribution Guide)
3.5 Phase 5: User Acceptance & Review
Present the generated <actual-project-name>-deep-dive.md to the user.
"The Project Architecture Deep Dive has been generated. Please review
<actual-project-name>-deep-dive.md. Let me know if you want to drill down into any specific module details or adjust the weight of any section."
4. Key Rules
Strictly adhere to the following rules during execution:
- Read-Only Source: Never modify the source repository.
- Content Weighting: Ensure the Chief Architect strictly adheres to the 60/40 ratio between Architecture/Modules and Engineering Practices.
- Document Formatting: The final output MUST follow professional technical writing standards (hierarchical numbering, no dual-language titles, consistent terminology).
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

