用途:readme-writer 有两个用途。常见用途是测量并改进任意英文散文的阅读难度,包括文档、邮件、提案、规格和计划;较窄的用途是按固定结构组织 README。
主要能力:通过脚本计算 Flesch-Kincaid 年级分数,并统计文本中前 1000 个最常见英文单词的覆盖率。资料强调必须实际运行脚本测量,不能凭目测估算音节数。
使用方式:对任意文本(不限于 Markdown)执行:cat FILE | ruby scripts/flesch_kincaid.rb;词汇覆盖分析执行:cat FILE | ruby scripts/vocabulary_profiler.rb。目标是把年级分数控制在 11 或以下,技术术语会拉高分数属正常,重点是让周边散文保持清晰。修改后需重新测量,并报告修改前后的分数。
写作建议:使用主动语态,保持名词短语简短直接,嵌套从句不超过一层,使用简单的 if/then 条件句,用 however、therefore、because 等过渡词明确逻辑关系。避免在名词前堆叠多个修饰语、混用或倒装条件句、让读者自行推断关系、在单句中塞入过多新概念、假设读者熟悉习语或文化背景。
README 结构:按“是什么与为什么”“安装与使用”“配置”“贡献”“项目布局”组织。格式上可使用 GitHub 风格提示块([!CAUTION]、[!IMPORTANT]、[!NOTE]、[!TIP]、[!WARNING]),首次引入关键概念时加粗,命令、文件名、配置键和值使用代码格式,示例使用具体名称而非通用占位符。
质量检查:年级分数不超过 11、词汇覆盖已测量、章节衔接自然、关键概念首次出现加粗、示例使用真实场景名、避免企业套话、术语一致、缩写首次定义、尽量使用主动语态。
限制:资料未提供安装步骤、依赖版本、支持语言范围或收费信息,暂未提供。