关于 german-technical-writing
german-technical-writing 是面向德语读者撰写技术文本的写作技能,提供术语、语域、可读性及常见翻译误区方面的指导。
主要功能
- 01直接用德语撰写技术文档
- 02依据反模式参考检查措辞
- 03采用规范的技术词汇
- 04按文档类型调整语域
- 05改善清晰度和排版节奏
适用场景
- 01起草德语技术文档
- 02撰写团队聊天、Jira 工单或 Wiki 内容
- 03检查译文中的直译表达
- 04精简技术说明并保留必要条件
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ netresearch/ german-technical-writing-skill --skill german-technical-writing安装后在 Claude Code 中输入/german-technical-writing确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
evals/evals.jsonreferences/anti-patterns.mdcognitive-accessibility.mdexamples.mdlexicon.mdno-editorializing.mdregister.mdtypografie-rhythmus.md详细介绍
德语技术写作
面向德语读者的内容应使用自然的德语技术语体,而不是先用英语写作,再用 DeepL 翻译成德语。
流程
- 直接用德语撰写,不要翻译。如果发现自己先用英语起草,就重新开始。
- 根据
references/anti-patterns.md逐句自查——动词、搭配、习语、公文腔。 - 使用词汇表——规范动词和外来词的词性:
references/lexicon.md。 - 根据内容类型匹配语体——Jira/wiki 使用非人称表达,聊天使用 ich/du:
references/register.md。 - 排版与节奏——破折号、复合词连写;每种表达机制只解释一次,变换句式和开头,示例后不加结论句:
references/typografie-rhythmus.md。 - 清晰易懂——指代明确,缩短内容时保留条件,优先调整结构,而非单纯压缩字数:
references/cognitive-accessibility.md。 - 不做评价——说明发生了哪些变化,不评价工作做得好不好:
references/no-editorializing.md。 - 自行判断一般的风格问题;绝不编造事实。 只有当歧义会改变技术陈述,且无法从上下文中消除时,才提出问题。
规则冲突时的优先级: 技术准确性和理解明确,优先于简洁、风格变化,以及降低机器感的目标。
常见反模式
| ❌ | ✅ |
|---|---|
| code bricht | schlägt fehl / wirft Exception |
| gefangen | erkannt / abgefangen |
| null returnen | null zurückgeben |
| Test failt | schlägt fehl |
| Fehler triggern | Fehler auslösen |
| auf Fehler hitten | auf Fehler stoßen |
| blockiert auf X | wartet auf X / hängt an X |
完整目录见 references/anti-patterns.md;示例详见 references/examples.md。
三个陷阱——三种规范都要遵守
过度强调其中一种,会让你陷入另一种:
- 英语主义(动词层面):使用英语表达,而德语已有规范说法。Test failt → schlägt fehl。上表和
anti-patterns.md针对的就是这一问题。 - 生硬直译(名词、搭配、习语):逐字翻译,而规范说法应是外来词或其他德语结构。Wurzelursache → Root Cause;blockiert auf X → wartet auf X;macht Sinn → ist sinnvoll。参见
anti-patterns.md和lexicon.md。 - 过度润色成公文腔:为避开前两个陷阱,转而使用僵硬的官方措辞和 AI 式对称结构——Datenbestand、Es handelt sich um、被动语态连用、每节都重复陈述事实。参见
anti-patterns.md和typografie-rhythmus.md。应使用自然的开发者口语(ins Gehege kommen、läuft voll、fliegt auf),这并不算违规;但如果习语取代了句子正在解释的机制,则不应使用(cognitive-accessibility.md)。
名词规则:如果德国开发者会在代码评审或站会上直接使用某个术语,就保留其英文形式——听起来像教科书标题的德语形式属于生硬直译。
范围说明
提交消息、MR/PR 描述、发行说明和内部 IT 项目工单(NRS、NRT、SRV*、IO*、LIC)使用英语——跳过它们。本规范规定的是如何用德语写作,而不是是否使用德语。
评论
支持 Markdown