skills.rest
xbklairith
xbklairithCOMMUNITY
Explore all skills by this author →
GitHub

documentation

Generate code docstrings, API references, READMEs, and Mermaid architecture diagrams.

2|1|Updated Nov 17, 2025
Search Tags:#architecture#documentation#API#readme#docs
One-click install
npx skills add https://github.com/xbklairith/kisune --skill documentation-xbklairith
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/xbklairith/kisune/tree/main/dev-workflow/skills/documentation
Command: npx skills add https://github.com/xbklairith/kisune --skill documentation-xbklairith

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates and standardizes documentation tasks, generating code docstrings, API references, architecture diagrams, and READMEs to improve maintainability.

Core Features & Use Cases

  • Code Documentation: Inline docstrings and explanations.
  • API Documentation: Endpoints, schemas, and error handling.
  • Architecture Diagrams: Mermaid or ASCII diagrams for system overview.
  • README Generation: Clear project overviews and usage examples.

Quick Start

Provide a code snippet or endpoint; ask the skill to generate docs or update existing ones.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate documentation for my codebase and APIs?▼

Generate comprehensive documentation by providing code snippets or API endpoints to produce language-specific docstrings, API specs, and READMEs. The Skill creates maintainable, structured documentation including Python docstrings, JSDoc, Javadoc, and XML comments tailored to your codebase.

What documentation formats does this support?▼

Supports code docstrings across Python, JavaScript, TypeScript, Java, and C#; API specifications; README files; and Mermaid architecture diagrams. Each format follows language-specific conventions and standards for your project type.

Can I use this for API documentation and architecture diagrams?▼

Yes. Generate API endpoint documentation with schemas and error handling, plus architecture diagrams in Mermaid format to visualize system design. Both outputs integrate into your documentation workflow.

How do I update existing documentation without starting from scratch?▼

Provide existing documentation alongside your code changes. The Skill updates docstrings, API references, and READMEs incrementally, maintaining consistency across your codebase while preserving established structure.

When should I generate documentation during development?▼

Generate documentation during feature completion for immediate maintainability, during onboarding to clarify system design, and at system handoff to ensure continuity. Timing improves knowledge retention and reduces future rework.

Does this work for README files and project overviews?▼

Yes. Generate clear README files with project overviews and usage examples based on your codebase structure. Output is ready to publish and helps new contributors understand your project quickly.

Related Skills

Explore More Content & Communication Skills→
Selfdb-ioSelfdb-io

code-documentation

Generate docstrings, README files, API docs, and architecture overviews from source code.

Community
Intermediate
SSiertsemaSSiertsema

documentation-tooling-selection

Evaluate documentation tooling against audience, content, and technical criteria.

Community
Advanced
mosheshammoshesham

api-design-reviewer

Lint OpenAPI specs for REST conventions and detect breaking changes.

Community
Advanced
arbgjrarbgjr

doc-blueprint

Generate standardized documentation blueprints from code templates into a docs/ folder.

Community
Basic