documentation

Generate JSDoc comments, README updates, and developer guides for implemented features.

15|3|Updated Jan 27, 2026
One-click install
npx skills add https://github.com/richardcb/oh-my-gemini --skill documentation-richardcb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/richardcb/oh-my-gemini/tree/main/skills/documentation
Command: npx skills add https://github.com/richardcb/oh-my-gemini --skill documentation-richardcb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive documentation for implemented features, ensuring that code is well-explained for both users and developers.

Core Features & Use Cases

  • Code Comment Generation: Adds JSDoc comments to TypeScript/JavaScript code.
  • README & Guide Updates: Modifies README files and creates developer guides for significant changes.
  • AI Context Updates: Updates GEMINI.md with new patterns or commands.
  • Use Case: After implementing a new authentication module, this Skill will add detailed JSDoc comments to the relevant code files, update the main README with usage instructions, and create a new developer guide explaining the module's architecture.

Quick Start

Use the documentation skill to generate documentation for the recently implemented user profile feature.

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 for TypeScript code automatically?

To generate JSDoc comments for TypeScript code, this documentation Skill analyzes implemented features and adds structured, standard-compliant JSDoc annotations directly to your code files. It ensures your code remains the single source of truth for documentation content.

What is the best way to update a README after implementing a new feature?

The best way to update a README after implementing a feature is using automated documentation generation to modify the file with usage instructions. This Skill ensures your README reflects recent software changes by treating the implemented code as the source of truth.

How do I create a developer guide explaining a new module's architecture?

You create a developer guide for a new module by generating structured documentation from the implemented code. This Skill formats architectural explanations and feature details into external developer guides, ensuring comprehensive coverage of the software logic.

Can I use automated documentation generation for JavaScript and TypeScript projects?

Yes, you can use automated documentation generation for JavaScript and TypeScript projects. This Skill supports JSDoc standards for code comments and applies structured formats for external documentation across both languages.

How does treating code as the source of truth improve technical writing?

Treating code as the source of truth improves technical writing by ensuring documentation content directly reflects the implemented software features. This approach synchronizes code comments, README files, and developer guides with actual application logic.

When do I need to update AI context files like GEMINI.md?

You need to update AI context files like GEMINI.md when significant changes introduce new patterns or commands into your codebase. This Skill automates these updates to maintain accurate context for AI-assisted development.