Agent skill · writing content · aiskillstore
repo-docs
This skill should be used when the user asks to "generate repository documentation", "create a README", "document API", "write architecture docs", "add CONTRIBUTING guide", "update repo docs", "document codebase", or mentions repository documentation, codebase analysis, or cross-repository integration documentation.
Why this skill is useful
Generates structured documentation templates for repository integration points and dependencies that the AI wouldn't reliably create on its own.
What it needs
About 5k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Repository Documentation Generate comprehensive, self-contained documentation for code repositories with awareness of cross-repository integration points and dependencies. Purpose Create and maintain repository documentation that includes README files, API documentation, contributing guides, and architecture documents. Each generated document is self-contained while explicitly documenting how the repository interacts with other repositories, services, and external dependencies. When to Use Trigger this skill when: User asks to "generate documentation for this repo" User mentions "create/update README", "document API", "write architecture docs" User asks about "how this repo connects to other repos" User requests "CONTRIBUTING guide" or "setup documentation" User wants to document integration points with other repositories Documentation Workflow Phase 1: Repository Analysis Before generating documentation, analyze the codebase to understand: 1. Repository Structure Use Glob to discover key files: README.md, package.json, pyproject.toml, go.mod, Cargo.toml, pom.xml, etc. Identify main source directories (src/, lib/, app/, internal/, etc.) Find configuration files (.env.example, docker/, k8s/, etc.) Locate existing documentation (docs/, .md files) 2. Cross-Repository Integration Discovery Search for imports/requires referencing other repos (use Grep for common patterns) Look for API client libraries pointing to internal services Find shared dependencies or monorepo references Identify external service integrations (databases, APIs, message queues) Check for .gitmodules, workspace declarations, or subpackage references 3. Technology Detection Identify primary programming language(s) Find frameworks and major dependencies Detect build systems and tooling Note testing frameworks and CI/CD configuration Phase 2: Document Generation For each document type, follow the structured templates in examples/. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/repo-docs