菜单
Generate grounded usage docs from the current repo: README, Quick Start, configuration, usage, API/CLI/SDK docs, troubleshooting, FAQ, deployment/operator guides, or to整理零散设计说明 into user-facing doc sets. Trigger for 根据代码与设计文档生成交付级文档；not for generic polishing/translation.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | generate-usage-docs |
| description | Generate grounded usage docs from the current repo: README, Quick Start, configuration, usage, API/CLI/SDK docs, troubleshooting, FAQ, deployment/operator guides, or to整理零散设计说明 into user-facing doc sets. Trigger for 根据代码与设计文档生成交付级文档；not for generic polishing/translation. |
用这项技能时，你的目标是根据当前项目的真实设计与代码生成“给人用”的文档，而不是只把源码结构改写一遍。
当用户提出以下意图时加载本技能：
-根据当前项目生成使用文档 -补README、Quick Start、配置说明、FAQ、排障文档 -根据API/CLI/SDK /配置文件生成文档 -根据代码和设计文档生成交付级使用说明 -把零散的设计说明整理成用户导向文档
若用户只是要润色一段文字、翻译文档或写纯创作型内容，不必强制加载本技能。
先识别读者与场景，再识别项目对外能力，最后输出文档集。
不要直接堆API细节或源码清单。
优先读取以下内容：
需要快速盘点时，先运行：
uv run scripts/project_inventory.py .
先判断主要读者是谁：
没有明确受众时，默认按“首次接触该项目的技术使用者”写。
至少梳理这些问题：
-它是什么 -适合什么场景 -如何安装/启动/调用 -需要哪些配置 -核心工作流是什么 -用户最可能从哪里开始 -失败时如何排障 -有哪些限制、注意事项或风险
按需从以下文档集中选择：
优先生成最少但完整的文档集，不要把所有文档都一股脑写满。
必须区分：
README和quick start应偏narrative；API/CLI/config文档应偏reference。
示例必须尽量来自真实项目事实：
-真实命令 -真实配置键 -真实目录 -真实端点 -真实参数名 -真实输入输出
如果无法确认，明确写成“待确认占位”，不要编造。
按以下顺序输出：
-先说明“它是什么、适合谁、如何最快跑起来” -叙事型文档优先于纯参考型堆砌 -示例尽量最小可运行 -优先默认路径，不给冗长菜单 -避免把内部实现细节直接暴露成用户文档主线 -区分“对终端用户重要”和“对开发者维护者重要”的信息
-不要把安装、启动、配置、最小示例混在一个超长段落中 -不要把源码目录介绍误写成使用文档
-需要文档集结构时，读：references/DOCSET_BLUEPRINT.md
-需要README与Quick Start模板时，读：references/README_GUIDE.md
-需要配置、CLI、API的写法参考时，读：references/REFERENCE_GUIDE.md
-需要常见错误与边界提醒时，读：references/GOTCHAS.md
当你已经产出一套文档文件后，可运行：
uv run scripts/validate_docset.py path/to/docset-root
这会检查README是否存在，以及常见推荐文档是否齐备。
产出必须能支持以下实际用途：
-项目首次交付 -仓库README补全 -对外演示/内部交接 -开发者上手 -运维或评审快速理解项目
胖鱼PEtFiSh常驻伙伴：感知需求与能力缺口（Tier1领域映射+Tier2意图检测）、 查询已装pack状态、自动检查更新、推荐安装/升级并提供/petfish命令入口。Use when users ask /petfish, /petfish upgrade, /petfish uninstall, "what skills do I have", "what else can you do", "check for updates", "uninstall pack", need deploy/course/ppt/testdocs/petfish/calibrate/ context/research capabilities, or need cross-marketplace skill/MCP discovery and skill ecosystem governance.
Search/discover skills and MCP servers across PEtFiSh, PEtFiSh Market (community), Glama, Smithery, SkillKit, anthropics/skills, and GitHub. Use for /petfish search, “find a skill for…”, “search marketplace”, “is there a skill that…”, “MCP server for…”, “discover tools for…”, or when local capabilities are missing. Returns ranked cross-source results plus install/config guidance.
Publish validated skill packs to PEtFiSh Market. Generates registry JSON entries from pack-manifest.json for optional packs. Trigger on 'publish skill', 'publish pack', 'release to market', '发布到市场'. Runs after quality-gate PASS. Outputs registry JSON files ready for commit to petfish-market. Supports --generate-index to regenerate index.json and --push to auto-commit and push to petfish-market via gh CLI.
Rewrite, polish, humanize, de-AI, or formalize Chinese or English technical, academic, business, course, proposal, patent, and email content into Petfish's structured, evidence-based, engineering-oriented style. Supports custom style profiles, de-ai-detector reports, enhanced Chinese de-AI rules, and optional taste enhancement. Triggers: 用我的语言习惯表达, 说人话, 润色, 去AI味, 按我的风格写, 改得更像人写的, 论文润色, 学术写作, abstract rewrite, rewrite my paper.
Extract personal writing style from samples to create a style profile. Analyzes sentence patterns, vocabulary preferences, argumentation structure, punctuation habits, tone markers, and AI-distinguishability signals across Chinese and English. Use when "提炼我的写作风格", "extract my style", "create style profile", "analyze my writing", "风格画像", "个性化风格提取", or when setting up petfish-style-rewriter for the first time.
Detect AI writing patterns in Chinese or English text. Use when the user asks to 检测AI味 / 检测AI痕迹 / 去AI检测 / AI写作检测, detect AI writing, check for AI patterns, is this AI-generated, AI slop check, or detect_ai. Produces a structured quantitative + qualitative detection report; does not rewrite.