doc-generator SKILL.md skillA

doc-generator from chainlesschain/chainlesschain is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add chainlesschain/chainlesschain/doc-generator@v1.0.0

Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
chainlesschain/chainlesschain
Path
desktop-app-vue/src/main/ai-engine/cowork/skills/builtin/doc-generator/SKILL.md
Versions recorded
4
Latest version
v1.0.0, committed Aug 28, 2026
First version recorded
Jun 3, 2026
Size
3,582 bytes
Repository stars
11
License
a license file GitHub does not identify

文档生成技能 - JSDoc/API文档/序列图/Changelog自动生成.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# 文档生成技能

## 描述

从源代码自动生成文档,包括 JSDoc/TSDoc 注释、IPC 处理器 API 参考、Mermaid 序列图、Git Changelog、模块 README 等。

## 使用方法

```
/doc-generator [目标路径] [选项]
```

## 文档类型

### JSDoc/TSDoc 注释生成

```
/doc-generator src/main/llm/session-manager.js --jsdoc
```

分析函数签名和实现逻辑,生成 JSDoc 注释:

- 参数类型和描述
- 返回值类型和描述
- @throws 异常说明
- @example 使用示例

### IPC 处理器参考文档

```
/doc-generator --ipc-reference src/main/
```

扫描所有 `ipcMain.handle()` 和 `ipcMain.on()` 注册,生成:

- 完整的 IPC 通道列表
- 每个处理器的参数和返回值
- 按模块分组的索引
- 调用示例

### 序列图生成

```
/doc-generator src/main/browser/computer-use-agent.js --sequence-diagram
```

从代码流程分析生成 Mermaid 序列图:

- 模块间调用关系
- 异步消息流
- 条件分支和循环

### Changelog 生成

```
/doc-generator --changelog v0.35.0..HEAD
```

从 Git 提交历史生成 Changelog:

- 解析 Conventional Commits (feat/fix/docs/refactor)
- 按类别分组
- 包含 PR 链接和作者
- Breaking Changes 高亮

### 模块 README

```
/doc-generator src/main/audit/ --readme
```

为目录生成 README.md:

- 模块概述和目的
- 文件清单和职责说明
- 公共 API 摘要
- 依赖关系
- 使用示例

## 输出格式

- `--format markdown` (默认) - Markdown 格式
- `--format html` - HTML 页面
- `--format jsdoc` - 内联 JSDoc 注释(直接插入源码)

## 示例

生成 JSDoc 注释:

```
/doc-generator src/main/utils/ --jsdoc
```

生成完整 IPC 参考:

```
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add chainlesschain/chainlesschain/doc-generator@sha256:2afc26319abd3425

The line at the top of this page pins the label v1.0.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_afesakwm32g5omlu.svg)](https://markdownregistry.com/a/art_afesakwm32g5omlu)

5 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 4 versions of this file, between Jun 3, 2026 and Aug 28, 2026, about one every 29 days.

versioncommittedcommitsizeaudit
v1.0.0 latest2026-08-28 44248c7 3,582 BA view · diff
v1.0.02026-08-28 177ec1b 3,565 BA view · diff
v1.0.02026-08-28 c29953e 3,551 BA view · diff
v1.0.02026-06-03 3b0b2dc 3,442 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (3582 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

chainlesschain/chainlesschain · 11 stars · license a license file GitHub does not identify · pushed 2026-11-06 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_afesakwm32g5omlu
GET https://markdownregistry.com/api/v1/resolve?ref=chainlesschain/chainlesschain/doc-generator
GET https://markdownregistry.com/api/v1/blob/2afc26319abd3425a0a027d0d6a5630c2c969b23d7421da6e59988971efdd859

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from chainlesschain/chainlesschain

cc-cli SKILL.md skill
chainlesschain/chainlesschain · .claude/skills/cc-cli/SKILL.md · Invoke ChainlessChain `cc` CLI commands from natural language. Triggers when the user wants to run any `cc …` action…
git:20260618.4898c75 · audit A · 11 stars
pdh-android-collect SKILL.md skill
chainlesschain/chainlesschain · .claude/skills/pdh-android-collect/SKILL.md · Collect a rooted Android device's real personal data into the Personal Data Hub (PDH) vault to feed the user's…
git:20260618.58d3bd9 · audit A · 11 stars
AGENTS.md AGENTS.md file
chainlesschain/chainlesschain · AGENTS.md
git:20261023.f06ee98 · audit A · 11 stars
CLAUDE.md CLAUDE.md file
chainlesschain/chainlesschain · CLAUDE.md
git:20260920.96ab90a · audit A · 11 stars
ab-compare SKILL.md skill
chainlesschain/chainlesschain · desktop-app-vue/src/main/ai-engine/cowork/skills/builtin/ab-compare/SKILL.md · Generate and compare multiple implementation variants with benchmarking and scoring
v1.0.0 · audit A · 11 stars
agent-browser SKILL.md skill
chainlesschain/chainlesschain · desktop-app-vue/src/main/ai-engine/cowork/skills/builtin/agent-browser/SKILL.md · Advanced browser automation for AI agents with snapshot-ref interaction pattern - navigate, snapshot interactive…
v1.0.0 · audit A · 11 stars
api-design SKILL.md skill
chainlesschain/chainlesschain · desktop-app-vue/src/main/ai-engine/cowork/skills/builtin/api-design/SKILL.md · Design RESTful APIs with best practices, conventions, and OpenAPI specs
v1.0.0 · audit A · 11 stars
api-docs-generator SKILL.md skill
chainlesschain/chainlesschain · desktop-app-vue/src/main/ai-engine/cowork/skills/builtin/api-docs-generator/SKILL.md · Generate API documentation from code - produce OpenAPI/Swagger specs, Markdown API references, request/response…
v1.0.0 · audit A · 11 stars
api-gateway SKILL.md skill
chainlesschain/chainlesschain · desktop-app-vue/src/main/ai-engine/cowork/skills/builtin/api-gateway/SKILL.md · Universal API gateway - connect to 100+ APIs with a unified interface, manage API keys, and chain API calls
v1.2.0 · audit A · 11 stars
api-tester SKILL.md skill
chainlesschain/chainlesschain · desktop-app-vue/src/main/ai-engine/cowork/skills/builtin/api-tester/SKILL.md · API测试技能 - IPC处理器发现、测试生成、健康检查、回归测试
v1.0.0 · audit A · 11 stars
architect-mode SKILL.md skill
chainlesschain/chainlesschain · desktop-app-vue/src/main/ai-engine/cowork/skills/builtin/architect-mode/SKILL.md · 双阶段架构模式 - 先规划后编辑,分离推理与代码修改,提升多文件编辑准确率
v1.0.0 · audit A · 11 stars
audio-transcriber SKILL.md skill
chainlesschain/chainlesschain · desktop-app-vue/src/main/ai-engine/cowork/skills/builtin/audio-transcriber/SKILL.md · Speech-to-text transcription using Whisper API or local engine
v1.0.0 · audit A · 11 stars

Every file in chainlesschain/chainlesschain

Other files named doc-generator

doc-generator SKILL.md skill
athola/claude-night-market · plugins/scribe/skills/doc-generator/SKILL.md · Generates or remediates documentation with human-quality writing. Use when creating new docs, rewriting AI-generated…
git:20260928.76a539b · audit A · 348 stars

Browse by kind, by grade A, or by owner.