code-documentation

Generate Markdown documentation for codebases and APIs.

60|13|Updated Dec 22, 2025
One-click install
npx skills add https://github.com/plurigrid/asi --skill code-documentation-plurigrid
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/plurigrid/asi/tree/main/skills/code-documentation
Command: npx skills add https://github.com/plurigrid/asi --skill code-documentation-plurigrid

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing effective code documentation for APIs, README files, inline comments, and technical guides to reduce onboarding time.

Core Features & Use Cases

  • README templates: Standard structure for quick starts and overviews
  • API reference & inline comments: Clear, consistent API docs and code explanations
  • Architecture docs: ADRs and architecture guidance to document decisions

Quick Start

Use the provided templates to document a new API endpoint; fill in the details and generate Markdown docs.

Frequently Asked Questions about code-documentation

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

FAQPage Schema
How do I write API documentation that's clear and maintainable?▼

API documentation should follow standard formats like OpenAPI and JSDoc to ensure consistency. This Skill generates comprehensive API references by mirroring your code structure and types, then produces Markdown docs with practical examples that reduce onboarding time and keep docs in sync with code changes.

What should a README include for a new project?▼

A README should have a quick-start guide, project overview, and installation steps. This Skill provides README templates with standard structure, helping you document setup, usage, and key features in a format that's easy for new developers to follow.

Can I document inline code comments and API endpoints in the same system?▼

Yes. This Skill handles both inline comments and API documentation consistently across JavaScript, TypeScript, Python, and other ecosystems, enforcing uniform style and structure so developers see a coherent documentation experience across README, API references, and code.

How do I document architecture decisions for future reference?▼

Architecture Decision Records (ADRs) capture the reasoning behind technical choices. This Skill generates ADR templates and guides that document decisions, trade-offs, and context, making it easy for teams to understand why architectural choices were made.

Does this work with Markdown and OpenAPI formats?▼

Yes. This Skill generates documentation in Markdown, OpenAPI, and JSDoc formats, conforming to standard specifications so your docs integrate with existing tools, API portals, and development workflows.

What happens if my codebase changes after I've documented it?▼

The Skill mirrors your code structure and types, so when you regenerate docs, they reflect current code. Using templates and consistent structure makes updates straightforward, keeping documentation accurate as your API evolves.