plain-language
一套用于编写清晰、易读且简洁内容的工具。应用“浅显语言运动”原则,包括主动语态、缩短句子和消除行话,以提升读者理解度。
简介
plain-language 技能为起草和润饰文本提供了系统性架构,以确保读者能立即理解内容。此技能专为撰稿人、开发人员和技术交流人员设计,特别适用于优先考虑清晰度而非复杂性的内容创建阶段。藉由运用 2010 年《浅显写作法案》(Plain Writing Act of 2010)及更广泛的“浅显语言运动”技巧,它有助于降低认知负荷、提升阅读速度并增进内容的易读性,即使是偏好直接沟通、厌恶模糊行话的技术人员也能受惠。
-
将主动语态的使用率提高至 80% 以上,确保沟通具备行动导向的直接性。
-
强制执行句子长度限制,将平均字数维持在 25 字以内以优化阅读体验。
-
提供消除行话的自动化指导,偏好简单、标准的术语而非晦涩难懂的流行语。
-
包含降低名词化(nominalization)以及删除模糊词或冗词的具体技巧。
-
将应用模式细分为教学(Tutorial)、操作指南(How-To)、参考资料(Reference)与说明(Explanation),以符合情境需求。
-
内建 Flesch-Kincaid 可读性与主动语态比例的衡量指标。
-
最适用于润饰文档、API 指南、技术教程或项目 README 文件。
-
使用者应监控输出内容中是否包含如 'was/were + past participle + by' 等被动语态标记。
-
预期输入为需要简化的草稿,输出则为更简洁、更有力且更易于阅读的修订版本。
-
限制:技术准确性需与清晰度取得平衡;仅在首次出现时定义明确的前提下,才允许使用专业行话。
-
建议用于管理高认知负荷可能成为采用障碍或影响开发者入门效率的内容。
-
在最终发布前,请务必使用提供的品质检查清单来审核是否符合可读性指标。
仓库统计
- Star 数
- 63
- Fork 数
- 17
- Open Issue 数
- 0
- 主要语言
- Python
- 默认分支
- main
- 同步状态
- 空闲
- 最近同步时间
- 2026年5月3日 09:28