1. はじめに
『テクニカルライティング Two』は読者の技術的コミュニケーションスキルを向上させることを目標とします。
対象読者
このコースの対象読者は『テクニカルライティング One』を読み終わり、さらなるテクニカルライティングの訓練を欲している貪欲な読者です。テクニカルライティングの訓練を全く受けたことがないのなら、この講座を受講する前に『テクニカルライティング One』を終わらせることを推奨します。
学習目標
このコースはテクニカルライティングにおける中級レベルのトピックに焦点を当てます。この講座を修了すれば、次の事項が習得できるでしょう:
- 初稿を書くためのいくつかの異なる戦略、そして第二稿と第三稿を書くためのそれとは別の戦略を使い分ける。
- 自分が書いた文章のミスを見つけるための複数のテクニックを使う。
- 大規模なドキュメントを構成する。
- ドキュメントの目的と前提知識を示す。
- 図に対する明快なキャプションを書く。
- 技術的な図では適切な情報密度を保つ。
- 技術的な図では読者が注目すべき場所を示す。
- "全体像"を示す図を使って文脈を伝える。
- 技術的な図を効率的に推敲する。
- 様々な複雑性を持ったサンプルコードを、実用的で、正確で、明快で、再利用可能で、多くのコメントが付いた状態で作成する。
- ドキュメントには様々な種類があることを意識する。
- とにかく全て説明する。
- 初心者の読者のことを考え、初心者のためのチュートリアルを書く。
エンジニアであれテクニカルライターであれ、優れた技術を習得するには長年に渡る集中的な修練が必要です。このコースはあなたのテクニカルライティングのスキルを向上させますが、瞬時にあなたを優れたテクニカルライターに変身させることはありません。
pre-class と in-class
このコースは次の二つの部分からなります:
- pre-class
- in-class
あなたは現在 pre-class 部の最初を読んでいます。
in-class 部では pre-class 部で学んだことをさらに深く学びます。ただし pre-class 部だけでも高い教育効果を得られます。
ハードウェアとネットワーク要件
このコースはノート PC とデスクトップ PC に最適化されていますが、タブレットやスマートフォンで受講することも可能です。in-class 部を受講する場合には、文字をたくさんタイプする必要があることに注意してください。
このコースの受講にはインターネット接続が必要です。コースのダウンロードはできません。またこのコースの物理メディア版は用意されていません。
このコースには短い動画がいくつか含まれますが、どれも飛ばして問題ありません。低帯域のインターネット接続でコースを受講する場合には動画をスキップしてください。