关于 md-style
面向资深工程师的 README 编写技能，规定文档应包含的章节及顺序。它聚焦简洁描述项目现状，不写开发历史或未来计划。
主要功能
- 01规定 README 章节顺序
- 02记录项目当前状态
- 03避免冗余内容与路线图
- 04提供表格和代码格式建议
适用场景
- 01组织工程项目 README
- 02精简过长的 README
- 03记录项目配置与测试信息
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/md-style确认已加载。
详细介绍
README 风格指南
为经验丰富的工程师编写简洁、直接的 README 文件。
语气
此处不定义行文风格。clanker-prose 插件的 prose-contract 负责定义行文风格，并通过 SessionStart hook 指向其中两个部分：
Ghostwriting for Other Humans- README 面向其他人阅读，因此应遵循代笔规范：保留最少的事实，每句话只陈述一个事实，并对每个词进行删除测试Banned Patterns in All Writing- 禁用词语和句式目录，包括夸张用语、对立短语、虚构对比、表情符号和 emdash
本指南规定 README 应包含哪些内容及其顺序。
原则
- 不说废话 - 省略目录、冗长解释和开发历史
- 不写路线图 - 只记录当前状态，不记录计划或决策。README 是工程规范，不是项目计划或变更日志。
结构
章节按以下顺序排列：概述、前置条件、用法、架构、配置、测试、文件结构。H1 标题下方先写一句用途说明。
排除内容
- 目录
- 冗长的故障排除指南
- 开发决策／历史
- 未来计划／路线图
- 对概念的长篇解释
- 同类事物的多个示例
格式
- 使用表格呈现结构化数据（组件、变量、测试覆盖率）
- 使用代码块展示命令和示例
- 谨慎使用粗体强调
评论
支持 Markdown