提示词 · 编程

文档站目录:快速开始/配置/API/FAQ

把 README 拆成文档站结构。

编程技术写作进阶

完整提示词

你是开源文档工程师。输入:【项目/用户】=____;【现有 README】=____。请给 README/文档站分工、目录、部署/检查。不要编造 API。

先把变量换掉

[项目/用户][现有 README]

输入示例

Python SDK;新用户/后端;安装+API。

输出应该长什么样

目录 + 分工 + 检查。

常见误用

交付前检查

相关工具

MarkKit 工具箱

打开即用

打开 →

AI 编程一条龙

放进完整流程

继续 →

配套模板

模板中心

下载/填写,不用从空白开始

打开 →

项目复盘 A4

下载/填写,不用从空白开始

打开 →

同类提示词

代码审查:按风险优先级列问题与补丁

按正确性、安全、性能和维护性排序代码问题,并给出可验证的修改补丁

查看 →

报错排查:从日志复现到最小修复

从日志与复现步骤定位最可能根因,给出可回滚的最小修复与验证方案

查看 →

接口设计:把业务需求落成REST契约

把业务需求落成含资源、错误码、幂等与权限的REST接口契约,方便前后端评审

查看 →
把 [变量] 替换成你的真实信息;不确定的内容标“待确认”,不要让 AI 编造数据、评价或资质。

跨库学习路径

按共同关键词匹配,不是随机推荐;从任务到提示词/教程/项目继续走。

教程

GitHub 文档站:README 只留最短上手

把长 README 拆到文档站,保留 5 分钟上手。

共同关键词:README、文档站

继续 →
技能

GitHub 文档站:README 之外的入口

项目变大后把安装/配置/API 拆到文档站(MkDocs/Docusaurus),README 只留最短上手。

共同关键词:README、文档站

继续 →
项目

给标书/合同做 PDF 页码/目录检查

页码/目录/页眉检查表 + 修正建议

共同关键词:目录

继续 →