mcpField
G
german-technical-writing

german-technical-writing

github.com/netresearchドキュメント8105 回インストール今日更新
リポジトリ

german-technical-writing について

german-technical-writingは、ドイツ語読者向けの自然な技術文を書くためのライティングスキルです。用語、文体、読みやすさ、翻訳調の表現を避ける方法を案内します。

主な機能

  1. 01ドイツ語で技術文書を直接執筆
  2. 02アンチパターン資料に沿った表現の確認
  3. 03標準的な技術用語の適用
  4. 04成果物に応じた文体の調整
  5. 05明瞭さと文章のリズムの改善

活用シーン

  1. 01ドイツ語の技術文書の作成
  2. 02チームチャット、Jiraチケット、Wikiの執筆
  3. 03技術文の翻訳調表現の確認
  4. 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.json
references/
anti-patterns.md
cognitive-accessibility.md
examples.md
lexicon.md
no-editorializing.md
register.md
typografie-rhythmus.md

詳細

ドイツ語の技術文書

ドイツ語圏向けの成果物にふさわしい、自然なドイツ語の技術文体を使います。英語で書いた文を DeepL でドイツ語に置き換えたような表現は避けます。

プロセス

  1. 翻訳するのではなく、最初からドイツ語で書きます。 先に英語で下書きしていると気づいたら、最初からやり直します。
  2. 各文を references/anti-patterns.md と照らし合わせて自己レビューします。 動詞、コロケーション、慣用表現、公用文調を確認します。
  3. 用語集を適用します。 標準的な動詞と外来語の性については references/lexicon.md を参照します。
  4. 成果物ごとに文体を合わせます。 Jira/Wiki では非人称表現、チャットでは ich/du を使います。references/register.md を参照してください。
  5. 表記とリズムを整えます。 思考ダッシュと複合語のハイフン表記を使います。それぞれの仕組みの説明は一度にとどめ、文型や書き出しに変化をつけ、例の後に結論の文を置きません。references/typografie-rhythmus.md を参照してください。
  6. わかりやすさを確保します。 指示対象を明確にし、短くしても条件を保ち、語数より構成を重視します。references/cognitive-accessibility.md を参照してください。
  7. 論評は加えません。 作業の良し悪しではなく、何が変わったかを述べます。references/no-editorializing.md を参照してください。
  8. 一般的な文体上の判断は自分で行い、事実を決して作り出しません。 技術的な記述に影響する曖昧さがあり、文脈から解決できない場合に限り、質問します。

ルールが衝突した場合の優先順位: 専門的な正確さと明確な理解を、簡潔さ、文体の変化、機械的に聞こえないことより優先します。

主なアンチパターン

❌✅
code brichtschlägt fehl / wirft Exception
gefangenerkannt / abgefangen
null returnennull zurückgeben
Test failtschlägt fehl
Fehler triggernFehler auslösen
auf Fehler hittenauf Fehler stoßen
blockiert auf Xwartet auf X / hängt an X

全項目については references/anti-patterns.md を、例については references/examples.md を参照してください。

3 つの落とし穴 — 3 つの原則をすべて適用する

1 つの原則を過剰に適用すると、別の落とし穴にはまります。

  1. 英語表現の直輸入(動詞レベル):ドイツ語に標準的な表現があるのに、英語を使うこと。Test failt → schlägt fehl。上の表と anti-patterns.md で対処します。
  2. 直訳調(名詞、コロケーション、慣用表現):外来語や別のドイツ語表現が標準的なのに、単語ごとに翻訳すること。Wurzelursache → Root Cause、blockiert auf X → wartet auf X、macht Sinn → ist sinnvoll。anti-patterns.md と lexicon.md を参照してください。
  3. 過剰に磨き上げた公用文調:この 2 つの落とし穴を避けようとして、堅苦しい公用文調や 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)は英語で記述します。対象外です。このガイドはドイツ語をどのように書くかを定めるものであり、書くかどうかを定めるものではありません。

コメント