mcpField
W
writing-clearly-and-concisely

writing-clearly-and-concisely

github.com/softaworks生产力2.6k4.3k 次安装34 周前更新
代码仓库

关于 writing-clearly-and-concisely

writing-clearly-and-concisely 面向撰写各类读者文本的人，涵盖文档、界面文案、报告和摘要。它运用 Strunk 的写作原则，并指出应避免的常见 AI 写作模式。

主要功能

  1. 01应用语法和标点规则
  2. 02使用主动、具体的表达
  3. 03删去不必要的词语
  4. 04改善段落结构
  5. 05避免常见 AI 写作模式

适用场景

  1. 01编辑技术说明
  2. 02理清 Pull Request 描述
  3. 03改进界面文案或错误消息
  4. 04精简报告或摘要

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/softaworks/agent-toolkit --skill writing-clearly-and-concisely

安装后在 Claude Code 中输入/writing-clearly-and-concisely确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

README.md
signs-of-ai-writing.md
elements-of-style/
01-introductory.md
02-elementary-rules-of-usage.md
03-elementary-principles-of-composition.md
04-a-few-matters-of-form.md
05-words-and-expressions-commonly-misused.md

详细介绍

清晰简洁地写作

概述

写作要清晰有力。本技能涵盖该怎么做（Strunk）以及该避免什么（AI 写作模式）。

何时使用本技能

只要你要为人类读者撰写文本，就使用本技能：

  • 文档、README 文件、技术说明
  • 提交说明、拉取请求描述
  • 错误消息、UI 文案、帮助文本、注释
  • 报告、摘要或任何说明文字
  • 为提升清晰度而进行的编辑

只要你是在写给人类阅读的句子，就使用本技能。

有限上下文策略

上下文有限时：

  1. 根据判断撰写草稿
  2. 将草稿和相关章节文件交给子 Agent
  3. 让子 Agent 进行文字编辑并返回修订稿

加载单个章节（约 1,000-4,500 个 token）而不是全部内容，可以显著节省上下文。

文体要素

William Strunk Jr. 的 The Elements of Style（1918）教你如何清晰写作并果断删减。

规则

基础用法规则（语法／标点）：

  1. 单数名词的所有格加上 's
  2. 列举时，除最后一项外，每项后都加逗号
  3. 用逗号括起插入语
  4. 引导并列分句的连词前加逗号
  5. 不要用逗号连接独立分句
  6. 不要把句子拆成两个
  7. 句首分词短语应修饰语法主语

写作的基础原则：

  1. 每个段落只写一个主题
  2. 段落以主题句开头
  3. 使用主动语态
  4. 采用肯定表达
  5. 使用明确、具体、形象的语言
  6. 删去不必要的词
  7. 避免连续使用松散的句子
  8. 用相似的形式表达并列观点
  9. 让相关词语保持紧邻
  10. 摘要中保持时态一致
  11. 把强调的词语放在句末
参考文件

以上规则总结自 Strunk 的原著。完整说明和示例请参阅：

章节文件~Tokens
语法、标点、逗号规则02-elementary-rules-of-usage.md2,500
段落结构、主动语态、简洁表达03-elementary-principles-of-composition.md4,500
标题、引文、格式04-a-few-matters-of-form.md1,000
选词、常见错误05-words-and-expressions-commonly-misused.md4,000

大多数任务只需 03-elementary-principles-of-composition.md——它涵盖主动语态、肯定表达、具体语言以及删去不必要的词。

应避免的 AI 写作模式

大模型容易回归统计平均值，产出泛泛而谈、浮夸冗长的文字。应避免：

  • 浮夸用语： pivotal、crucial、vital、testament、enduring legacy
  • 空洞的“-ing”短语： ensuring reliability、showcasing features、highlighting capabilities
  • 宣传性形容词： groundbreaking、seamless、robust、cutting-edge
  • 过度使用的 AI 词汇： delve、leverage、multifaceted、foster、realm、tapestry
  • 过度使用格式： 项目符号过多、用表情符号装饰、隔几个词就加粗

具体表达，不要夸夸其谈。说清楚它实际能做什么。

有关这些模式成因的全面研究，请参阅 signs-of-ai-writing.md。Wikipedia 编辑制定了本指南，用于识别 AI 生成的投稿——其中列出的模式有充分记录，也经过了实际检验。

总结

为人类读者写作？加载 elements-of-style/ 中的相关章节并遵循规则。大多数任务只需查看 03-elementary-principles-of-composition.md，即可掌握最重要的要点。

评论

支持 Markdown