用途:在创建或撰写 README.md 文件时使用,帮助生成简短、聚焦的 README 文档。
主要能力:写 README 时保持简短,不包含许可证(licensing)或贡献(contribution)章节。始终提供展示命令行界面的速查表。
使用方式:速查表用一个代码块承载全部调用示例,每个示例上方配一行简短注释说明用途,注释与命令同处一个块内。不要为每个示例单独建围栏代码块、单独写说明句或单独加标题。说明性文字应放在代码块的上方或下方,用于解释工具是什么以及读者无法自行推断的规则,不要写在命令之间。展示输出是可选的,多数速查表不展示;若展示输出,被捕获的输出必须真实而非编造,且不要求每个命令都配输出块,仅当命令结果本身就是重点时(例如 JSON 记录或解析错误)才展示对应输出。
适用场景:为命令行工具编写 README 及其速查表时。
限制:资料未提供安装命令、收费、价格、平台或具体实现细节。