skills.rest
saajunaid
saajunaidCOMMUNITY
Explore all skills by this author →
GitHub

documentation-analyzer

Analyze codebases to generate README content, API references, and architecture diagrams.

Updated Feb 20, 2026
Search Tags:#development#architecture#documentation#onboarding#readme#code-analysis#api-docs
One-click install
npx skills add https://github.com/saajunaid/junai --skill documentation-analyzer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-analyzer
Source: https://github.com/saajunaid/junai/tree/main/.github/skills/docs/documentation-analyzer
Command: npx skills add https://github.com/saajunaid/junai --skill documentation-analyzer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyze codebases to generate comprehensive documentation that explains code functionality and architecture, enabling teams to understand systems faster and maintain code with confidence.

Core Features & Use Cases

  • Automated codebase discovery: identify modules, packages, dependencies, and entry points.
  • Dependency analysis and pattern recognition to map architecture and design decisions.
  • Documentation generation: produce README structures, API references, and architecture diagrams for onboarding and maintenance.

Quick Start

Run the Documentation Analyzer on a project to generate a complete README draft, architecture diagrams, and API references.

Frequently Asked Questions about documentation-analyzer

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

FAQPage Schema
How do I generate API documentation and architecture diagrams from an existing codebase?▼

You can generate API documentation and architecture diagrams by running automated codebase analysis to identify modules, dependencies, and entry points, mapping design patterns to produce structured references and visual representations.

What is the best way to create a comprehensive README draft for onboarding developers?▼

The best way to create a README draft for onboarding is to use systematic codebase discovery to extract module functionality and architecture details, producing structured documentation content for new team members.

Can I use automated code analysis to map dependencies across projects of varying sizes and languages?▼

Automated code analysis can be applied to projects of varying sizes and languages, identifying dependencies and recognizing patterns to map architecture and design decisions across the codebase.

Does codebase documentation generation work for producing both development notes and API references?▼

Codebase documentation generation works for producing both development notes and API references by analyzing code functionality and architecture through phase-based analysis to output comprehensive maintenance documentation.

What are the limitations of automated documentation generation for complex architectures?▼

A limitation of automated documentation generation is that while it maps dependencies and produces diagrams, complex architectural nuances may require manual review to ensure the generated development notes accurately reflect system behavior.

Related Skills

Explore More Software Engineering Skills→
superfhpsuperfhp

codebase-inspection

Analyze codebases with pygount to calculate lines of code and language breakdowns.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
Chang-Shih-YungChang-Shih-Yung

health

Aggregate type checker, linter, and test results into a 0-10 composite score.

Community
Advanced
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic