humanize

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Humanize Developer Text

让开发者文本更具人文风格

Fix AI-generated writing patterns in docs, docstrings, commit messages, PR descriptions, and code comments. Prioritize deletion over rewriting — the best fix for filler is removal.
修复文档、docstrings、commit messages、PR描述和代码注释中AI生成的写作模式。优先删除而非改写——解决冗余内容的最佳方式就是移除。

Core Principles

核心原则

  1. Delete first, rewrite second. Most AI patterns are padding. Removing them improves the text.
  2. Use simple words. Replace "utilize" with "use", "facilitate" with "help", "implement" with "add".
  3. Keep sentences short. Break compound sentences. One idea per sentence.
  4. Preserve meaning. Never change what the text says, only how it says it.
  5. Match the register. Commit messages are terse. READMEs are conversational. API docs are precise.
  6. Don't overcorrect. A slightly formal sentence is fine. Only fix patterns that read as obviously AI-generated.
  1. 先删除,后改写。大多数AI写作模式都是冗余的填充内容。移除它们能直接提升文本质量。
  2. 使用简单词汇。将“utilize”替换为“use”,“facilitate”替换为“help”,“implement”替换为“add”。
  3. 保持句子简短。拆分复合句,每句只表达一个核心意思。
  4. 保留原意。绝不改变文本要传达的信息,仅调整表述方式。
  5. 匹配文本场景。commit messages要简洁凝练,README需通俗易懂,API文档要精准严谨。
  6. 不过度修正。略微正式的句子无需修改,仅修复那些明显带有AI生成痕迹的表述。

Fix Strategies by Category

按类型分类的优化策略

Content Patterns

内容模式

TypeStrategyRisk
Promotional languageReplace superlatives with specificsNeeds review
Vague authorityDelete the claim or add a citationSafe
Formulaic structureRemove the intro/conclusion wrapperNeeds review
Synthetic openersDelete the opener, start with the pointSafe
Before:
markdown
In today's rapidly evolving software landscape, authentication is a crucial
component that plays a pivotal role in securing modern applications.
After:
markdown
This guide covers authentication setup for the API.
类型优化策略风险等级
宣传式表述用具体内容替换夸张形容词需要人工审核
模糊的权威性表述删除该表述或添加引用来源安全
公式化结构移除开头/结尾的套话需要人工审核
无意义的开场白删除开场白,直接切入主题安全
优化前:
markdown
In today's rapidly evolving software landscape, authentication is a crucial
component that plays a pivotal role in securing modern applications.
优化后:
markdown
This guide covers authentication setup for the API.

Vocabulary Patterns

词汇模式

TypeStrategyRisk
High-signal AI wordsDirect word swapSafe
Low-signal clustersReduce density, keep 1-2Needs review
Copula avoidanceUse "is/are" naturallySafe
Rhetorical devicesDelete the question, state the factSafe
Synonym cyclingPick one term, use it consistentlyNeeds review
Commit inflationRewrite to match actual change scopeNeeds review
Word swap reference:
AI WordReplacement
utilizeuse
leverage (as "use")use
delvelook at, explore, examine
facilitatehelp, enable, let
endeavortry, work, effort
harnessingusing
paradigmapproach, model, pattern
whilstwhile
furthermorealso, and
moreoveralso, and
robust (non-technical)reliable, solid, strong
seamlesssmooth, easy
cutting-edgemodern, latest, new
pivotalimportant, key
elevateimprove
empowerlet, enable
revolutionizechange, improve
unleashrelease, enable
synergy(delete — rarely means anything)
embarkstart, begin
Before:
text
feat: Leverage robust caching paradigm to facilitate seamless data retrieval
After:
text
feat: add response caching for faster reads
类型优化策略风险等级
典型AI高频词汇直接替换词汇安全
无意义词汇堆砌精简密度,仅保留1-2个核心词汇需要人工审核
刻意回避系动词自然使用“is/are”安全
修辞性问句删除问句,直接陈述事实安全
同义词滥用选定一个术语并保持一致需要人工审核
Commit信息浮夸改写以匹配实际变更范围需要人工审核
词汇替换参考:
AI词汇替换词
utilizeuse
leverage (作“使用”义)use
delvelook at, explore, examine
facilitatehelp, enable, let
endeavortry, work, effort
harnessingusing
paradigmapproach, model, pattern
whilstwhile
furthermorealso, and
moreoveralso, and
robust (非技术语境)reliable, solid, strong
seamlesssmooth, easy
cutting-edgemodern, latest, new
pivotalimportant, key
elevateimprove
empowerlet, enable
revolutionizechange, improve
unleashrelease, enable
synergy(直接删除——几乎无实际意义)
embarkstart, begin
优化前:
text
feat: Leverage robust caching paradigm to facilitate seamless data retrieval
优化后:
text
feat: add response caching for faster reads

Formatting Patterns

格式模式

TypeStrategyRisk
Boldface overuseRemove bold from non-key termsSafe
Emoji decorationRemove emoji from technical contentSafe
Heading restatementDelete the restating sentenceSafe
Before:
markdown
undefined
类型优化策略风险等级
过度使用粗体移除非关键术语的粗体格式安全
表情符号装饰从技术文档中移除表情符号安全
标题重复表述删除重复标题的句子安全
优化前:
markdown
undefined

Error Handling

Error Handling

Error handling is a critical aspect of building reliable applications. The
handleError
function catches and processes all runtime errors.

**After:**
```markdown
Error handling is a critical aspect of building reliable applications. The
handleError
function catches and processes all runtime errors.

**优化后:**
```markdown

Error Handling

Error Handling

The
handleError
function catches runtime errors and logs them with context.
undefined
The
handleError
function catches runtime errors and logs them with context.
undefined

Communication Patterns

沟通模式

TypeStrategyRisk
Chat leaksDelete entirelySafe
Cutoff disclaimersDelete entirelySafe
Sycophantic toneDelete or neutralizeSafe
Apologetic errorsRewrite as direct error messageNeeds review
Before:
python
undefined
类型优化策略风险等级
聊天式冗余内容直接删除安全
时效性免责声明直接删除安全
谄媚语气删除或中性化表述安全
道歉式错误信息改写为直接明确的错误提示需要人工审核
优化前:
python
undefined

Great implementation! This elegantly handles the edge case.

Great implementation! This elegantly handles the edge case.

As of my last update, this API endpoint supports JSON.

As of my last update, this API endpoint supports JSON.


**After:**
```python

**优化后:**
```python

Handles the re-entrant edge case from issue #42.

Handles the re-entrant edge case from issue #42.

This endpoint accepts JSON.

This endpoint accepts JSON.

undefined
undefined

Filler Patterns

冗余内容模式

TypeStrategyRisk
Filler phrasesDelete the phraseSafe
Excessive hedgingRemove qualifiers, state directlySafe
Generic conclusionsDelete the conclusion paragraphSafe
Before:
markdown
It's worth noting that the configuration file might potentially need to be
updated. Going forward, this could possibly affect performance.
After:
markdown
Update the configuration file. This affects performance.
类型优化策略风险等级
冗余短语删除该短语安全
过度模糊表述移除限定词,直接陈述安全
通用结论删除结论段落安全
优化前:
markdown
It's worth noting that the configuration file might potentially need to be
updated. Going forward, this could possibly affect performance.
优化后:
markdown
Update the configuration file. This affects performance.

Code Docs Patterns

代码文档模式

TypeStrategyRisk
Tautological docstringsDelete or add real informationNeeds review
Narrating obvious codeDelete the commentSafe
"This noun verbs"Rewrite in active/direct voiceSafe
Exhaustive enumerationKeep only non-obvious paramsNeeds review
Before:
python
def get_user(user_id: int) -> User:
    """Get a user.

    This method retrieves a user from the database by their ID.

    Args:
        user_id: The ID of the user to get.

    Returns:
        User: The user object.

    Raises:
        ValueError: If the user ID is invalid.
    """
    return db.query(User).get(user_id)
After:
python
def get_user(user_id: int) -> User:
    """Raises UserNotFound if ID doesn't exist in the database."""
    return db.query(User).get(user_id)
类型优化策略风险等级
同义反复的docstrings删除或添加实际有效信息需要人工审核
陈述代码显而易见功能的注释删除该注释安全
“This noun verbs”式表述改写为主动/直接语态安全
过度详尽的参数枚举仅保留非显而易见的参数说明需要人工审核
优化前:
python
def get_user(user_id: int) -> User:
    """Get a user.

    This method retrieves a user from the database by their ID.

    Args:
        user_id: The ID of the user to get.

    Returns:
        User: The user object.

    Raises:
        ValueError: If the user ID is invalid.
    """
    return db.query(User).get(user_id)
优化后:
python
def get_user(user_id: int) -> User:
    """Raises UserNotFound if ID doesn't exist in the database."""
    return db.query(User).get(user_id)

Developer Voice Guidelines

开发者写作风格指南

Good developer writing is:
  • Conversational but precise. Write like you'd explain it to a colleague, but get the details right.
  • Direct. State opinions. "Use X" not "You might consider using X".
  • Terse where appropriate. Commit messages and code comments should be short. Don't pad them.
  • Specific. Replace vague claims with concrete details, numbers, or examples.
  • Consistent. Pick one term and stick with it. Don't cycle synonyms.
优质的开发者写作应具备以下特点:
  • 通俗易懂且精准严谨。像给同事讲解一样写作,但要确保细节准确。
  • 直接明确。清晰表达观点,用“使用X”而非“你可以考虑使用X”。
  • 按需简洁。commit messages和代码注释应简短,避免冗余。
  • 具体详实。用具体细节、数据或示例替代模糊表述。
  • 保持一致。选定一个术语并持续使用,避免同义词滥用。

Register Guide

文本场景风格参考

ArtifactToneLengthExample
Commit messageTerse, imperative50-72 chars
fix: prevent nil panic in auth middleware
Code commentBrief, explains why1-2 lines
// retry once — transient DNS failures are common in k8s
DocstringPrecise, adds valueWhat the name doesn't tell you
"""Raises ConnectionError after 3 retries."""
PR descriptionStructured, factualContext + what changed + how to testBullet points, not paragraphs
READMEConversational, scannableAs short as possibleStart with what it does, then how to use it
Error messageActionable, specificWhat happened + what to do
Config file not found at ~/.app/config.yml. Run 'app init' to create one.
文档类型语气长度示例
Commit message简洁、命令式50-72个字符
fix: prevent nil panic in auth middleware
代码注释简短、解释原因1-2行
// retry once — transient DNS failures are common in k8s
Docstring精准、补充信息补充名称无法传达的内容
"""Raises ConnectionError after 3 retries."""
PR描述结构化、事实性上下文 + 变更内容 + 测试方法使用项目符号,而非段落
README通俗易懂、易扫描尽可能简短先说明功能,再讲解使用方法
错误提示可操作、具体说明问题 + 解决方案
Config file not found at ~/.app/config.yml. Run 'app init' to create one.

Applying Fixes

优化方案的应用

Safe Fixes (Auto-Apply)

可自动应用的安全优化

These are mechanical and can be applied without human review:
  • Delete chat leaks ("Certainly!", "Great question!")
  • Delete cutoff disclaimers ("As of my last update")
  • Delete filler phrases ("It's worth noting that")
  • Delete heading restatements
  • Remove emoji from technical docs
  • Remove excessive bold formatting
  • Swap high-signal AI vocabulary (utilize -> use)
  • Delete "As we can see" / "Let's take a look at"
  • Delete narrating-obvious comments
这些优化属于机械性操作,无需人工审核即可应用:
  • 删除聊天式冗余内容(如“Certainly!”、“Great question!”)
  • 删除时效性免责声明(如“As of my last update”)
  • 删除冗余短语(如“It's worth noting that”)
  • 删除标题重复表述
  • 从技术文档中移除表情符号
  • 移除过度的粗体格式
  • 替换典型AI高频词汇(如utilize -> use)
  • 删除“As we can see” / “Let's take a look at”这类表述
  • 删除陈述代码显而易见功能的注释

Needs Review Fixes (Interactive)

需人工审核的优化(交互式)

These require a human to verify the replacement preserves intent:
  • Rewriting promotional language (may need domain knowledge)
  • Fixing synonym cycling (need to pick the right term)
  • Rewriting tautological docstrings (need to decide what's actually worth documenting)
  • Trimming exhaustive parameter docs (need to decide which params are non-obvious)
  • Rewriting commit messages (scope judgment)
  • Restructuring formulaic sections (may change document flow)
  • Fixing apologetic error messages (wording matters for UX)
这些优化需要人工验证替换内容是否保留了原意:
  • 改写宣传式表述(可能需要领域知识)
  • 修正同义词滥用问题(需选定正确术语)
  • 改写同义反复的docstrings(需判断哪些内容值得记录)
  • 精简过度详尽的参数文档(需判断哪些参数是非显而易见的)
  • 改写Commit信息(需判断变更范围)
  • 重构公式化章节(可能会改变文档流程)
  • 修正道歉式错误信息(措辞会影响用户体验)