@artale/pi-doc
扫描项目导出，生成API文档与README的文档工具
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：@artale/pi-doc。 它的用途是：扫描项目导出，生成API文档与README的文档工具 详细介绍见：https://321skill.com/skills/artale-pi-doc/ 请根据该页面的说明完成安装。
使用示例
'用@artale/pi-doc扫描当前项目src目录的导出，生成API参考并检查文档覆盖率'，它会自动执行扫描，输出覆盖率报告并生成对应API文档。
对AI说：'用pi-doc为我的npm包生成基础README脚手架'，它会提取项目配置与导出信息，生成标准化README初稿。
介绍
开发者维护项目或开源库时，手动编写API参考、README不仅耗时费力，还常出现导出项遗漏、文档与代码不同步、文档覆盖不全的问题，手动梳理接口、核对覆盖范围效率极低且容易出错。
安装完成后，只需配置项目的扫描入口路径，工具即可自动扫描所有导出内容，统计文档覆盖情况，还能一键生成标准化README脚手架与完整API参考文档，无需手动逐个整理接口信息。
适合维护开源npm包的开发者、负责模块文档的前端/Node.js开发人员、需要快速补全项目文档的研发团队，尤其适配迭代频繁、导出接口较多的项目维护场景。
使用前建议先明确项目的导出入口配置，确保扫描路径准确无误，生成文档初稿后，可根据项目的业务特性补充自定义说明，不建议直接发布未经过人工校验的自动生成内容。
核心特点
相较于普通文档生成工具，它同时集成文档覆盖率检查、README脚手架生成能力，可直接扫描项目导出项提取接口信息，无需额外手动标注接口。
注意事项
仅支持JavaScript/TypeScript生态项目，无法自动生成涉及复杂业务逻辑的说明内容。
常见问题
pi-doc支持扫描TypeScript项目吗？
支持，可识别TS类型定义与导出项，生成对应类型说明。
自动生成的README可以自定义模板吗？
支持基础配置调整，生成初稿后可自由修改内容与结构。