Skip to content
Agentmart
Submit a tool

doc-writer

需要从代码生成文档时使用 — 自动生成 API 文档、README 或模块说明

Skill by noobke

IndexedMIT★ 3
Write a review

Install

Works with Claude Code, Claude apps, Codex, Cursor, Gemini CLI, GitHub Copilot, VS Code, OpenCode, Goose, Windsurf. Read the repository before you give any tool access to your data.

npx agentmarket install skill/noobke-doc-writer

Asks which of your tools to add it to (Claude Code, Codex, Cursor, VS Code, Windsurf, Gemini CLI, Claude Desktop) and shows the change first. See https://agentmart.dev/cli.

Get the weekly diff

The weekly diff: one email a week with new agent tools, notable updates and grade changes, plus security alerts for tools you follow. Double opt-in, one-click unsubscribe.

We use your email only for this newsletter. Privacy

About

需要从代码生成文档时使用 — 自动生成 API 文档、README 或模块说明

Use cases: documents, backend

Reviews

Write a review

No reviews yet. Installed it? Reviews come from verified installers only. How reviews work

Permissions

What this skill can do and what it asks for, from its SKILL.md. Checked Oct 25, 2026.

Tools
No tools found
Secrets
None asked for
Install scripts
None found

Network hosts it talks to 1

  • codeload.github.com · found in install command

Files it touches

  • ~/.claude/skills/doc-writer

What's inside

Skill name
doc-writer
Description
需要从代码生成文档时使用 — 自动生成 API 文档、README 或模块说明
License
MIT
Instructions
28 lines in SKILL.md · view on GitHub

Agent Skills spec issues

  • name: missing

Files (1)

  • SKILL.md

SKILL.md (first lines)

# Doc Writer — 文档生成

从代码自动生成 API 文档、README 或模块说明。

## 流程

1. **确定范围** — 用户指定的文件/目录，或从当前上下文推断
2. **读取代码** — 使用 `get_symbols` 获取结构，`read_file` 阅读关键部分
3. **提取信息** — 导出函数/类、参数、返回值、异常
4. **生成文档** — 按目标格式输出

## 文档类型

| 类型 | 格式 |
|------|------|
| API Reference | 函数签名 + 参数表 + 返回值 + 示例 |
| README | 概述 + 安装 + 快速开始 + API + 示例 |
| Module Doc | 用途 + 公共 API + 内部结构 + 依赖 |

## 输出格式

根据用户指定的文档类型，生成相应的 markdown 文件。包含：
- 清晰的标题层级
- 代码示例
- 类型签名（TypeScript 项目）
- 注意事项/陷阱

From noobke/reasonix-skills, MIT.

More from noobke/reasonix-skills

Signals

Stars
3
Forks
0
Open issues
0
Last commit (this folder)
May 28, 2026 (5 months ago)

From GitHub (fetched Oct 24, 2026).

Details

License
MIT
Repository
github.com/noobke/reasonix-skills
First seen
Oct 24, 2026
Last checked
Oct 24, 2026
Source
GitHubgithub-graphql

More from noobke

Cite this page

doc-writer skill. Agent Mart. https://agentmart.dev/skills/noobke-doc-writer (last updated 2026-10-24)