skills.rest
Geralt1983
Geralt1983COMMUNITY
Explore all skills by this author →
GitHub

Documenter

Generate README files, API documentation, code comments, and ADRs.

1|1|Updated Jan 6, 2026
Search Tags:#documentation#technical writing#adr#readme#code comments#api docs
One-click install
npx skills add https://github.com/Geralt1983/Thanos --skill documenter-geralt1983
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Documenter
Source: https://github.com/Geralt1983/Thanos/tree/main/.gemini/skills/documenter
Command: npx skills add https://github.com/Geralt1983/Thanos --skill documenter-geralt1983

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating high-quality, maintainable documentation for software projects and technical content, ensuring clarity and usability for any audience.

Core Features & Use Cases

  • Comprehensive Documentation Generation: Create READMEs, API references, inline comments, and Architecture Decision Records (ADRs).
  • Audience-Aware Content: Tailors documentation to the specific needs of the reader.
  • Use Case: You've just finished a new feature and need to document it. This Skill can help you write a clear README section, add necessary docstrings to your code, and even draft an ADR explaining the technical choices made.

Quick Start

Use the Documenter skill to write a README for the current project.

Frequently Asked Questions about Documenter

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

FAQPage Schema
How do I generate API documentation and inline code comments for my project?▼

You can generate API documentation and inline code comments by providing your source code to the Documenter skill. It formats outputs into standard structures like Python docstrings, JSDoc, and Javadoc, ensuring clarity and audience appropriateness.

What is the best way to write an Architecture Decision Record in Markdown?▼

An Architecture Decision Record (ADR) in Markdown is best drafted by defining the technical choices and context of your feature. This skill generates Markdown-based ADRs that clearly explain architectural decisions to your target audience.

Can I tailor technical writing to different reader audiences?▼

Yes, technical writing can be tailored to specific reader audiences. The skill adjusts the generated README files and API references to match the clarity and accuracy needs of the intended software engineering or technical communication audience.

Does this tool support both Python docstrings and Javadoc generation?▼

Yes, the tool supports both Python docstrings and Javadoc generation. It handles multiple documentation formats including JSDoc and Markdown-based ADRs, covering comprehensive technical writing needs across different programming environments.

How do I write a comprehensive README for a new software feature?▼

To write a comprehensive README for a new feature, describe the functionality and intended user context. This skill generates clear README sections that document your technical choices and maintain usability for software projects.

Related Skills

Explore More Software Engineering Skills→
phuhao00phuhao00
12

code-analyst-agent

Analyze source code to identify symbols, call graphs, and architectural patterns.

Community
Intermediate
georgekhananaevgeorgekhananaev
27

md

Enforce consistent Markdown syntax across documentation and README files.

Community
Basic
abudhahirabudhahir

documentation-generator

Generate JSDoc, Python docstrings, Rustdoc, Javadoc, and GoDoc documentation.

Community
Intermediate
xiaoniuge36xiaoniuge36
6

code-review

Analyze code for standards compliance, bugs, performance issues, and security vulnerabilities.

Community
Advanced