skills.rest
prometh-sh
prometh-shOFFICIAL
Explore all skills by this author →
GitHub

prometh-doc

Generate standardized README, runbook, and concept documentation from repository analysis.

4|Updated Aug 17, 2025
Search Tags:#templates#documentation#runbook#getting-started#repo-analysis#concept-docs
One-click install
npx skills add https://github.com/prometh-sh/prometh-context-framework --skill prometh-doc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: prometh-doc
Source: https://github.com/prometh-sh/prometh-context-framework/tree/main/.opencode/skills/prometh-doc
Command: npx skills add https://github.com/prometh-sh/prometh-context-framework --skill prometh-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically create complete project documentation by analyzing repository structure and configurations to deliver ready-to-use templates.

Core Features & Use Cases

  • Auto-detects repository structure and tech stack to tailor documentation templates.
  • Generates a complete documentation set including README, getting-started, and CONTRIBUTING, plus concept docs when needed.
  • Supports metadata injection for concept docs when configured via a tracking file.

Quick Start

Describe your project and prompts, and Prometh Doc will generate README.md, docs/getting-started.md, CONTRIBUTING.md, and concept docs as needed.

Frequently Asked Questions about prometh-doc

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

FAQPage Schema
How do I generate project documentation from a repository automatically?▼

Generating project documentation automatically involves analyzing the repository structure and configuration files to produce standardized templates. The tool detects the tech stack and outputs files like README, runbooks, and concept docs adapted to the specific architecture.

What types of documentation templates can I create for my tech stack?▼

Documentation templates you can create include README, getting-started guides, CONTRIBUTING files, runbooks, and concept documentation. These templates adapt to the detected programming language, tooling, and architecture of your specific tech stack.

Does auto-generated documentation work for different programming languages and architectures?▼

Yes, automated documentation generation adapts to diverse tech stacks by detecting the repository's language, tooling, and architecture. It adjusts the output templates to match the specific configurations and structural patterns found in the project.

How do I inject metadata into concept docs using a tracking file?▼

Injecting metadata into concept docs requires configuring a tracking file within the repository. When this configuration is detected, the documentation generator automatically populates the concept documentation with the specified metadata during the template creation process.

Where should generated documentation files be routed in a repository?▼

Generated documentation files are routed to either the project root directory or a dedicated docs directory. The output routing adapts to the existing repository structure to place README, runbook, and concept files in the appropriate locations.

Related Skills

Explore More Content & Communication Skills→
trysmrtrysmr

reload-context

Reload user memory, project memory, and README content into a Markdown context block.

Community
Basic
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
atlassianatlassian
949

generate-status-report

Generate status reports from Jira issues and publish them to Confluence.

Official
Intermediate
akillnessakillness
40

api-documentation

Generate API documentation from OpenAPI specs or code annotations.

Community
Advanced