ottijp blog

Googleが公開しているTechnical Writingの紹介

2022-06-06

休日のスキマ時間でGoogleが公開しているTechnical Writingというコンテンツを読みました.

cf. Technical Writing  |  Google Developers

技術文書の書き方についての学習コンテンツなのですが, 書き方だけではなく,英語の技術文書を読む力もつくので,オススメです. 各章は10分くらいで読めるので,スキマ時間でちょいちょい読み進めることができます.

コース

Technical Writing OneとTechnical Writing Twoの2つのコースがあります.

Technical Writing One

単語,構文,段落などに関する内容です.学習所要時間は2時間くらいでした. ベーシックな英語構文の話から始まりますが,中学の授業より本質的で必要なことだけ学べるので効率的で良いです. 読者を定義すること(これはOne, Twoを通じて繰り返し強調される)や,文書スコープを宣言することなど, ただ文書を書くだけでなく,文書を有用で効果的なものにするためのHow-toが学べます.

Technical Writing Two

ドキュメントの構成などに関する内容です.学習所要時間は1時間くらいでした. 章節や段落の構成方法や,良い図表,良いサンプルコードの書き方などが学べます. 図を書く前にキャプションを決めることや,アウトラインファーストなど, 文書作成に限定されない重要な考え方にも言及されています.

所感

英語での技術文書の書き方がテーマですが,ほとんどは英語に限定されない内容であり, 日本語での技術文書作成に対しても,とても有用な内容でした.

この業界では,英語の技術文書を一次情報として読むことが多いですが,良い書き方を知ることで, 良い(効果的,効率的な)読み方も身につくと感じました.

マーティン・ファウラーのブログが読みやすいなぁといつも感じていたのですが, 技術文書の書き方が上手く,特に(関係)代名詞を適切に使っているからだなと腑に落ちました.


Satoshi SAKAO (@ottijp)

都内でアプリケーションエンジニアをしています

...
© 2022, ottijp