提取README核心字段并标注占位符
先从你最近一次写得最完整的README提示词入手。通读三遍,把那些实际会发生变动的部分全部标记出来:项目名称、技术栈、安装命令、启动方式、环境依赖、贡献指引、许可证类型。这七个字段是必须提取的变量,缺一不可。
将这些字段替换成用【】包裹的语义化占位符,例如【项目名称】、【主语言/框架】、【安装命令】、【启动命令】、【最低Node版本】、【贡献流程链接】、【许可证简称】。注意:【许可证简称】不能简化为“License”这种模糊写法,必须填写“MIT”“Apache-2.0”“GPL-3.0”等真实值,否则后续自动校验会失败。
原始提示词中的硬性输出约束也要保留。比如“不使用Markdown标题层级超过##”“依赖列表必须用无序列表+emoji前缀”“每个代码块必须带语言标识”。这些是README可读性的底线,一旦删除,生成的内容在GitHub页面上极易出现排版错乱。
封装为带校验的夸克AI模板文档
有两种实际可用的方法。
方法一:用夸克文档创建结构化模板。新建一个夸克文档,标题填写“READ ME生成模板_v2”,将整理好的占位符提示词粘贴到正文,点击右上角「更多」,选择「设为AI写作模板」保存。下次使用时,直接打开这个文档,替换所有【】内的文字,然后点击「让AI写」即可自动生成。
方法二:用书签保存预填充URL,适合固定技术栈的团队。在夸克浏览器地址栏输入构造好的URL(需要将中文标点转义、空格用%20替代),然后全选、右键「添加到书签」,命名为“READ ME_通用版”。注意一个细节:URL里的所有中文标点必须转义,空格必须用%20,否则点击书签会跳转失败或触发错误搜索。这个坑很多人已经踩过。
对接开发流程自动触发
第一步:在GitHub仓库根目录创建.quark-prompt.yml文件,内容格式如下:
template: "READ ME生成模板_v2"
fields:
项目名称: "{{repo.name}}"
主语言/框架: "{{tech.stack}}"
安装命令: "npm install"
启动命令: "npm run dev"
最低Node版本: "v18.17.0"
贡献流程链接: "https://github.com/xxx/contributing"
许可证简称: "MIT"
第二步:新仓库初始化完成后,打开夸克APP,扫描这个YAML文件的二维码,AI会自动识别字段并填充模板,直接生成可用的README。
第三步:将生成的结果复制到README.md中,保存并推送。操作非常简单,直接把文本拖进VS Code编辑器即可完成。
