# documentation

> Generate and maintain project documentation from source code and markdown files

- Author: defmarshal
- Repository: defmarshal/NimeDo
- Version: 20260122110612
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-06
- Source: https://github.com/defmarshal/NimeDo
- Web: https://mule.run/skillshub/@@defmarshal/NimeDo~documentation:20260122110612

---

---
name: documentation
description: Generate and maintain project documentation from source code and markdown files
---

# Documentation Generation Skill

## Overview
This skill generates and maintains project documentation from source code comments, JSDoc annotations, and markdown files. It helps keep documentation up-to-date with code changes.

## When to Use This Skill
- When starting a new project that needs documentation
- When updating API documentation after code changes
- When generating README files from code comments
- When creating user guides from existing documentation
- When publishing documentation to external sites

## Core Capabilities
- Generate API documentation from JSDoc comments
- Create README files from project structure
- Convert code comments to documentation
- Update documentation based on code changes
- Support for multiple documentation formats (HTML, Markdown, PDF)
- Integration with documentation hosting platforms

## Configuration
The skill respects existing configuration files in the project:
- `jsdoc.conf.json` for JSDoc settings
- `.doxygen` for Doxygen settings
- `typedoc.json` for TypeDoc settings
- `mkdocs.yml` for MkDocs settings

## Examples
- "Generate API documentation for the user module"
- "Update README with new features"
- "Create documentation for the payment API"
- "Convert JSDoc comments to markdown"

## Additional Notes
- Well-documented code produces better documentation
- Follow consistent commenting standards across the project
- Regular documentation updates improve maintainability
- The skill can integrate with CI/CD pipelines to automatically update docs