documentation

Generate and update technical documentation for codebases and APIs.

7|3|Updated Mar 17, 2026
One-click install
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill documentation-brainbrewlabs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/brainbrewlabs/brainbrew-devkit/tree/main/plugin/config/templates/develop/skills/documentation
Command: npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill documentation-brainbrewlabs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps engineers and maintainers quickly generate and update technical documentation for individual files, functions, and APIs so codebases stay understandable and on-boardable without manual proofreading of every comment.

Core Features & Use Cases

  • Inline documentation: Add JSDoc, Python docstrings, GoDoc, or Rustdoc comments that match project conventions.
  • README and docs pages: Create or update README.md and single-file markdown docs with installation, usage, and examples.
  • API and signature docs: Document endpoints or function signatures with parameter descriptions, return values, and examples.
  • Verification: Re-read code to confirm parameter names, types, return behavior, and highlight ambiguities needing manual review.

Quick Start

Document the function in src/utils/math.ts by adding JSDoc comments that describe purpose, parameters, return values, and include a short usage example.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate JSDoc comments and Python docstrings for existing code?

The Skill generates API docs by reading your source files to document individual endpoints or function signatures, providing concise parameter descriptions, return values, and examples while highlighting any ambiguities needing manual review.

Can I use this to add documentation to a single file in my repository?

Yes, you can apply this to single files within a repository. It reads the specific source file, detects the language-specific documentation format, and matches the existing project style before generating the required documentation and a list of modified files.

How does this approach ensure my generated README sections match my project style?

It ensures style matching by reading your source files and detecting existing language-specific documentation formats. It then applies these detected conventions to produce README sections, installation guides, and usage examples that align with your project.

What's the best way to document function signatures and API endpoints accurately?

The best way to document function signatures is using a verification process that re-reads the code to confirm parameter names, types, and return behavior, ensuring the generated API docs are accurate and highlighting ambiguities for manual review.

Does this support generating GoDoc and Rustdoc comments alongside JSDoc?

Yes, it supports generating GoDoc and Rustdoc comments. The Skill detects language-specific documentation formats across your codebase and applies the appropriate inline comment style to match your project's existing conventions.