テクニカルライティングの基本テクニカルライティングの基本を学べます。サイボウズの新入社員向け研修資料です。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 Twitter：https://twitter.com/naoh_nak 2023年度のアップデート版もあります：https://spe…
質の高い技術文書を書く方法 - As a Futurist...
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
上司が“唸る”報告書 の書き方｜５つの具体的なテクニックや文例集など
1.報告書の構成 報告書とは、上司や関係者に必要な情報を提供するための文書のことです。３層構造（標題→内容要旨→詳細内容）で、情報の整理や要約をしていきます。 例えば、日時、場所、目的、内容等について、情報を簡潔に記入します。 また、所感は記入する場合と、しない場合があります。その場の細かなニュアンスを伝えたほうが有効な場合には、所感も書くようにします。 【報告書（例）】 〔pdf〕打ち合わせ報告書 〔pdf〕営業報告書 1-1.報告書の全体構成 注意すべき点は、以下の三角形の図のように、「標題」は「内容要旨」（打ち合わせ内容）の要約、 「内容要旨」は「詳細内容」（ヒアリング事項等）の要約という３層構造を理解することです。 実際、報告書を上から（標題から）順に書こうとするから難しいのであって、 報告書の説明文（詳細内容から）順に書いていけば、割と楽に書けます。 【報告書の構造（下位にいくほ
ひとつ上のヒューマンマネジメント 10年後も通用する文章術(1) 「駄目でない」文章を書くための9カ条
私は企業のIT企画部門の課長としてチームメンバーの文章をチェックしています。また，教育コンサルタントとしてビジネス文章を教えたり，国家試験科目の論文添削をしています。 異なる立場で非常に多くの文章を見てきたので，今では「どんな文章が駄目なのか」がよく分かるようになりました。ここから紹介するのは「よい文章を書く技術」です。 「よい文章」とは「駄目でない文章」 私は人に「よい文章を書くコツは何ですか？」とよく聞かれます。そのときにはいつも，「駄目な文章を書かないようにすることです」と答えています。 人が何をもって「よい文章だ」と感じるかどうかは，極めて主観的なものだと考えています。個人の受け止め方や感じ方に依存する部分が多いからです。 では，ビジネス文書でも「よい文章」を書かなくてはいけないのでしょうか。もちろん，それができるに越したことはありません。 しかし，どんな人でも「うまい」と言わせる
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
部下から「議事録ってなんで作成する必要あるんですか？」と聞かれたので議事録の必要性について図解してみた
