README 构造器
构建一个适合项目及其读者的 README。将用户视为设计师。预设只是提案,结构、内容和视觉元素是独立的选择。使用项目证据和用户已有的决策。绝不虚构功能、命令、结果、图片或声明。
发现并提案
在提出建议方案前,检查相关仓库、现有文档、生成文档的源文件以及资产。识别 README 的目的、目标读者、标题、语气和渲染目标(当其影响设计时)。遵守要求的输出路径或仅聊天草稿。当输出生成时,编辑文档源文件。保留有用的事实和现有资产,尤其是对于已有的 README。
有选择地使用下面的菜单。它们的模式为用户提供了可供选择并适应的选项。其链接示例是从 Awesome README 索引 中选取的代表性子集,并附有简短的原注释。使用该技能无需网络访问。
对于新 README 或重大改版,提供一个量身定制的、可编辑的方案,显示建议的标题顺序、每个章节的内容选择以及任何单独放置的视觉元素。仅在选择仍具有实质性内容时包含简要的上下文选择。在紧凑的菜单中使用稳定 ID,以便用户可以添加、删除、重命名或重新排序章节,独立选择其内容,并选择个别视觉元素。适当提供 none、keep、skip、recommend 和自由文本选项。说明 recommend 是委托选择。让用户独立于预设来决定内容和视觉元素。
采纳用户已给出的选择,并在修改方案时保留它们。当在改版中使用 keep 选择现有项时,保留并应用该项。仅询问未解决的设计选择,并将其分组为可管理的信息。在起草新的或实质性改版 README 之前等待这些选择,除非用户已委托决策。如果用户给出了足够的指示或要求您决定,则使用合适的默认值继续。一旦选择解决,则按要求交付,无需再次寻求批准。对于窄幅编辑,直接执行用户的请求,无需启动新的构造器会话。
将此紧凑交互适应到项目中。
建议顺序为
S1 概述 → S2 快速入门 → S3 架构。内容选择为S1 问题 + 范围、S2 最小命令和S3 纯文本组件图。视觉选择为V1 截图位于 S1 之后(建议,无可用资源)和V2 架构图位于 S3 之后(建议)。选择章节和顺序,更改任何章节的内容,并单独选择视觉元素。keep接受特定的建议值,none删除章节或视觉元素,skip跳过可选项,recommend委托决策。欢迎自定义文本。用户选择
顺序 S1, S3, S2 / S2 引导式 / V1 none / V2 keep / 保留其余项。
生成的方案保留 S1 和 S3 的内容,对 S2 使用引导式快速入门,省略 V1,并将 V2 放置在 S3 之后。解决任何剩余的实质性不确定性,而不重新讨论已接受的选择。区分建议的资产和现有资产。仅在用户要求的范围和可用工具内制作或获取建议的资产,否则省略该资产并解释差距。
生产并检查
按照选择的方案编写章节,并从项目中提供具体支持。在可行的情况下安全地验证命令。标记未经验证的命令或缺失的信息,避免仅仅为了测试文档而执行具有破坏性或副作用的命令。检查所选平台的标题顺序和链接、锚点、Markdown 渲染、代码围栏和语言标签以及相对资产路径。为有意义的图像提供信息性替代文本,并使用视觉元素时检查其在浅色和深色主题下的易读性。保留请求范围之外的现有内容。报告结果中的实质性差距和验证限制。