Send feedback Stay organized with collections Save and categorize content based on your preferences. Every engineer is also a writer. This collection of courses and learning resources aims to improve your technical documentation. Learn how to plan and author technical documents. You can also learn about the role of technical writers at Google.
はじめに エンジニアにとって、仕様書などの技術的な文章を書くこと(テクニカルライティングとも言います)は避けて通れません。ただ20年来多くのエンジニアの方々と同僚として接してきて思うことは、エンジニアの方の中には「文章を書く」ということに苦手意識がある方が一定数いるということです。 でもこの「テクニカルライティング」のスキルは、才能というよりは一種の「技能」だと思うんです。ある一定の原理原則を理解して実践を繰り返すことで、必ず一定レベルで習得できるものだと著者は信じています。 もしこのテクニカルライティングの原理原則をまだ体系的に学習したことがない、または過去学習したが改めて再学習したいという方に、お勧めのコンテンツを見つけたのでご紹介します。 https://developers.google.com/tech-writing Every engineer is also a write
レポート及び論文では「基本的な能力を有した日本語ユーザーであれば誰でも理解できる(誤解しない)」精確な(=精密で的確な)日本語を書くことが求められます。その能力を身に付ける第一歩として,以下のルールを必ず守ってください。中には瑣末なモノも含まれますが,これらを守るだけで添削・修正の手間も再提出の可能性も格段に下がります。これらの基本的な書式が守られていないレポートは添削せずに送り返します。 1. 「何となく伝わるだろう」は絶対にNGです。書いてある通りにしか解釈できない,逆に言えば,その他の(拡大)解釈や曲解を許さない厳密な文章を書くことを心がけましょう。 2. そのためにも,まずは主語を明確にすること。「書かなくても伝わるだろう」「好意的に解釈してくれるだろう」という期待を読み手に押し付けてはいけません。 3. 主語を明確にしたら,主語に述語を対応させましょう。主述が対応していないという
と思っている話です。もはやタイトルでぜんぶ言ってしまった。 せっかくなのでもう少し続けます。 2020/05/03追記:第二弾?書きました この本がまだ初稿になる前、共著者のみなさんと執筆真っ最中の頃に何度か打ち合わせがあったのですが、そこで「書籍的な文章を書き慣れてない人って、"という"と"こと/もの"を多用しがちなので、この2つを抑えるだけでも文章がシュッとするんですよ」とお話したら思ったより反応があったので、これは需要があるんじゃないかと感じたのがきっかけです。 ここから先は具体例を交えて解説していきます。 さすがに他人様のテキストを使うのは気が引けるので自分が書いた記事を例に挙げます。……でも自分はこのテクニックを使うようにしているので、該当する記事がなかなかないんですよねぇ……と思ったらあった! (よりによってこれか……せっかくなので皆さんスタァライトを観ましょう!) 記事中では
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く