md-style 是 jimweller/clanker-skills 中的一项技能,定位为 README 风格指南,用途是在编写或编辑 README 文件时提供结构与写作规范。资料显示,它面向有经验的工程师,强调简洁、直接的表达。
主要内容包括:原则方面,要求避免冗余,跳过目录和冗长解释,不写开发历史;不写路线图,只记录当前状态,把 README 当作工程规格而非项目计划或变更日志。结构方面,章节顺序为 Overview、Prerequisites、Usage、Architecture、Configuration、Testing、File Structure,并在 H1 标题下用一句话说明用途。排除项包括目录、冗长的故障排查指南、开发决策与历史、未来计划与路线图、冗长的概念解释,以及多个相似示例。格式方面,结构化数据可用表格,命令与示例用代码块,强调时谨慎使用加粗。
资料还说明,行文风格本身不在该技能中定义,而由 clanker-prose 插件的 prose-contract 负责,并通过 SessionStart 钩子指针注入其两个部分:面向他人代笔的契约,要求最小事实、每句一个事实、对每个词做删除测试;以及所有写作中的禁用模式清单,包括炒作词汇、对立短语、幻影对照、表情符号和长破折号。
使用方式与具体命令资料暂未提供;该技能适用于需要保持 README 一致、精简的团队或个人。限制方面,它只覆盖 README 应写什么以及顺序,不定义通用行文风格,也不涉及收费、平台或效果信息。