AI Skill 大全

软件文档编写与重整

读取项目源码、现有文档和使用目标,编写或重整教程、操作指南、接口参考与原理说明,交付可直接使用的文档。

功能与用途

适合为软件项目新建文档,或整理内容混杂、步骤缺失的旧文档。提供项目源码、现有说明或接口资料,并说明面向的读者与希望完成的任务,即可得到对应的入门教程、操作指南、接口参考或原理说明,也可用于改写 README、部署手册和新人上手材料。成稿会明确前置条件、操作步骤和预期结果,并核对可查证的命令、字段及链接。需要提供足够的项目资料或允许读取相关文件;无法确认的信息会明确标注。

适用场景

  • 编写项目上手教程:结合项目文件与安装说明,编写包含前置条件、操作步骤和预期结果的新手教程。
  • 整理接口参考文档:依据接口实现和已有定义,系统说明参数类型、默认值、约束、错误及调用示例。
  • 补齐部署操作手册:将部署配置与现有说明整理为可执行的操作指南,补充结果检查和常见故障处理。
  • 重整混杂的文档集:将混在一起的教学步骤、操作说明、接口参考和架构解释拆成目标清晰的文档。

适用人群

  • 软件开发者
  • 技术文档工程师
  • 开源项目维护者
  • 开发者关系工程师
  • 运维工程师

使用步骤

  1. 提供项目资料或指定可读取的文件。
  2. 说明目标读者及需要解决的具体问题。
  3. 指定编写新文档、修改旧稿或重整文档集。
  4. 获取成稿,查看步骤、示例及待确认信息。

开始使用

将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。

查看 MCP 接入说明

技术信息

分类
编程
适用工具
Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
使用难度
简单
版本
81a48b4
最近更新
2026-11-06
文件数
5
安装包大小
自动生成 ZIP
安全检查
基础检查通过

>

使用前准备

  • 提供相关源码、现有文档、接口定义或配置资料,或允许读取项目中的相关文件。
  • 说明目标读者、文档用途和覆盖范围;未明确时可依据已有资料作合理假设。

依赖与权限

  • SKILLHUB_PUBLIC_BASE_URL
  • SKILLHUB_WEB_BASE_PATH
  • SKILLHUB_WEB_API_BASE_URL
  • ACTUATOR_BASE_URL
  • SKILLHUB_TOKEN
  • YOUR_API_TOKEN

同类 Skill