AI项目文档生成Skill

智能化工具自动生成开源项目README.md和CHANGELOG.md，支持多平台分发，无需手动编写。

Security Scan

The skill's code and instructions are internally consistent with a local README/CHANGELOG generator; there are minor documentation/install mismatches but no signs of credential access, networking, or other disproportionate privileges.

Purpose & Capability

The name/description (generate README.md and CHANGELOG.md) matches the provided app.py implementation which generates changelogs and READMEs locally. Minor mismatch: SKILL.md and some docs mention '一键分发' and 'npx clawhub install' / an 'ai-doc-generator' CLI, but no installer, Node package, or distribution code is included — distribution/platform integration is only documented (PLATFORMS.md), not implemented in code.

Instruction Scope

SKILL.md and README suggest running an 'ai-doc-generator' CLI via npx, but the actual runnable entry is python app.py with subcommands (changelog/readme). The runtime instructions do not ask for file reads outside argv, environment variables, or network access — the script only processes input strings and prints output.

Install Mechanism

There is no install spec and the skill is instruction-plus-source (app.py). Nothing is downloaded or written during install by the registry metadata. This is low-risk; users will need to run the Python script or package it themselves.

Credentials

The skill declares no required environment variables, no credentials, and the code does not access environment variables, network endpoints, or external secrets. Requested privileges are minimal and proportionate.

Persistence & Privilege

always is false and the skill does not request persistent presence nor modify other skills or system configs. It runs locally and prints output; no elevated privileges are requested.

Assessment

This appears to be a simple, local Python tool to generate README and changelog text — the core code (app.py) is self-contained and does not access the network or secrets. Before installing or exposing it to an agent: 1) Note the mismatch between SKILL.md (npx/ai-doc-generator) and the actual entrypoint (python app.py); you will run it with python app.py <changelog|readme>. 2) If you expect automatic distribution to other platforms, understand that distribution steps are documented but not implemented — you would need to package/integrate it yourself. 3) Review the source (app.py) if you plan to let an agent invoke it autonomously; while harmless now, any future modifications could add network or secret access. 4) If you want a CLI named ai-doc-generator or Node-based install, require the publisher to provide a proper installer or packaging info. Overall the skill is coherent and low-risk, but verify usage expectations (CLI name/installation) before relying on the documented install steps.

# AI 项目文档生成器

一个智能化的项目文档自动生成工具，支持一键生成符合开源标准的 README.md 和 CHANGELOG.md，支持多平台分发。

## 功能特性

- 自动化生成：一键生成专业的项目文档，无需手动编写

- 智能分析：深度分析代码仓库结构，提取关键信息

- 双文档支持：同时生成 README 和 Changelog 两种核心文档

- 多平台兼容：支持 ClawHub、有道龙虾 等全平台分发

- 零依赖：纯 Python 实现，无额外平台依赖

## 使用方法

\# 安装

npx clawhub install ai-doc-generator



\# 运行

ai-doc-generator ./your-project