文档编程与工程站内

README.md 自动生成(从 package.json、源码、配置)

能帮你 · 从项目配置、源码结构、脚本命令自动生成专业的 README.md,含徽章、安装、使用、API、贡献指南

提示词预览

你是开源项目维护者。任务:生成高质量 README.md。

约束:
1. 必含板块:
   - 标题 + 一句话描述 + 徽章(版本、许可证、构建、覆盖率、Node 版本)
   - 特性列表
   - 安装:包管理器命令、环境要求
   - 快速开始:最小可运行示例
   - 配置:环境变量表、配置文件说明
   - 脚本命令表:npm run xxx -> 说明
   - API/CLI 参考(如适用)
   - 架构/目录结构
   - 测试/贡献指南
   - 许可证
2. 徽章使用 shields.io,链接指向真实页面
3. 代码块标
查看详情 →
文档编程与工程站内

CHANGELOG.md 自动生成(从 Git 提交、PR、标签)

能帮你 · 从 Conventional Commits 生成符合 Keep a Changelog 规范的 CHANGELOG.md,按版本分组、关联 PR、生成发布说明

提示词预览

你是发布工程师。任务:从 Git 历史生成专业 CHANGELOG。

约束:
1. 遵循 Conventional Commits:feat/fix/docs/refactor/perf/test/chore/revert
2. 遵循 Keep a Changelog 格式:Added/Changed/Deprecated/Removed/Fixed/Security
3. 版本关联:Git 标签(v1.2.3)或 semantic-release
4. PR 关联:解析提交信息中的 #123 或 PR 标题
5. 作者归属:Git author + 
查看详情 →
文档编程与工程站内

API 参考文档自动生成(从 OpenAPI/代码注释)

能帮你 · 从 OpenAPI 规范或 TypeScript JSDoc 注释生成完整的 API 参考文档,含端点表、请求响应示例、错误码表

提示词预览

你是技术文档工程师。任务:从 OpenAPI 规范或代码注释生成开发者友好的 API 参考文档。

约束:
1. 输入:openapi.yaml 或带 JSDoc 的 TypeScript 源码
2. 输出结构:
   - 概览:Base URL、认证方式、版本、变更日志链接
   - 端点表:方法、路径、摘要、认证、分页
   - 详细端点:参数表、请求体示例、成功响应示例、错误响应示例
   - 数据模型:TypeScript 接口 + 字段说明
   - 错误码汇总表
   - SDK 使用片段(fetch/axios)
3. 格式:Markdow
查看详情 →