document-generator

document-generator is a skill for Claude Code, Codex from fuzhengwei/xfg-skills-template. It costs 60 tokens per session (599 once invoked), scanned A, original, Apache-2.0.

A guide for creating technical documents such as README files, API references, and changelogs. A README explains how a project works, while a changelog records its releases and changes.

In plain words
What is it for?
Use it to generate or update project documentation, API endpoint descriptions, installation instructions, usage examples, and release notes.
Why use it?
It gives common documentation types a consistent structure and keeps examples, links, and formatting easier to check.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to generate or update project documentation, API endpoint descriptions, installation instructions, usage examples, and release notes.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/fuzhengwei/xfg-skills-template/document-generator
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add fuzhengwei/xfg-skills-template --skill document-generator
Clone the repo
git clone --depth 1 https://github.com/fuzhengwei/xfg-skills-template

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for document-generator

README.md
[![agentmods](https://agentmods.dev/badge/skills/fuzhengwei/xfg-skills-template/document-generator/github.svg)](https://agentmods.dev/skills/fuzhengwei/xfg-skills-template/document-generator)
Your own site
<a href="https://agentmods.dev/skills/fuzhengwei/xfg-skills-template/document-generator"><img src="https://agentmods.dev/badge/skills/fuzhengwei/xfg-skills-template/document-generator/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for document-generator

Your own site · 80×15
<a href="https://agentmods.dev/skills/fuzhengwei/xfg-skills-template/document-generator"><img src="https://agentmods.dev/badge/skills/fuzhengwei/xfg-skills-template/document-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 60 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 599 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00060 $0.00599
Opus 5.5 $0.00024 $0.00240
Sonnet 5.5 $0.00012 $0.00120
Haiku 4.5 $0.00006 $0.00060

Measured 2mo ago against content hash 5ad0e9474330, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

document-generator scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

examples/document-generator/SKILL.md · 125 lines

What it actually says

文档生成技能

生成符合社区标准的技术文档。

支持的文档类型

README.md

使用以下模板:

# 项目名称

> 一句话描述项目

## 功能特色

- 特色 1
- 特色 2

## 快速开始

### 安装
```bash
npm install package-name

使用

import { feature } from 'package-name';

配置

参数 类型 默认值 说明

API 文档

详见 API.md

许可证

Apache-2.0


### CHANGELOG.md

遵循 [Keep a Changelog](https://keepachangelog.com/) 格式:

```markdown
# Changelog

## [Unreleased]

## [1.0.0] - 2025-01-15

### Added
- 新功能描述

### Changed
- 变更描述

### Fixed
- 修复描述

### Removed
- 移除描述

API 文档

# API Reference

## Endpoint: GET /users

**描述**: 获取用户列表

**参数**:
| Name | Type | Required | Description |
|------|------|----------|-------------|

**响应**:
```json
{ "example": "response" }

错误码:

Code Message Description

## 工作流

1. 分析项目结构和现有代码
2. 确定需要生成的文档类型
3. 使用对应模板生成文档
4. 检查文档完整性和准确性

## 文档质量标准

- 所有代码示例必须是可运行的
- 所有链接必须有效
- 中英文之间有空格
- 表格对齐整齐
- 代码块指定语言类型

## Gotchas

- README 不要过度美化,内容 > 格式
- CHANGELOG 面向人类读者,不要自动生成无意义的条目
- API 文档中的示例应该是真实可用的,不是伪代码
- 项目有 `.github/` 目录时,也要检查 ISSUE_TEMPLATE 和 PR_TEMPLATE
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 125 lines · 60 tokens per session scan A 5ad0e9474330

Subscribe to this mod's changes

document-generator is a skill published in the GitHub repository fuzhengwei/xfg-skills-template (15 stars, last pushed 5mo ago), licensed Apache-2.0. It adds 60 tokens to every session and 599 once invoked, about $0.0002 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

document-generator compared with skills from other repositories

document-generator next to 6 skills from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
document-generatorfuzhengwei/xfg-skills-templateSkill155mo agoApache-2.0A60Claude Code, Codex
imagegenopenai/codexSkill133kyesterdayApache-2.0A113Codex
playwright-climicrosoft/playwrightSkill99kyesterdayApache-2.0A19Claude Code
local-ai-agentsmicrosoft/ai-agents-for-beginnersSkill79k4d agoMITA200Claude Code, Codex
systematic-debuggingobra/superpowersSkill313k3d agoMITA21Claude Code
next-cache-components-adoptionvercel/next.jsSkill143ktodayMITA95Claude Code
next-partial-prefetching-adoptionvercel/next.jsSkill143ktodayMITA103Claude Code