テクニカルライティングの基本を学べます。サイボウズの新入社員向け研修資料です。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 Twitter:https://twitter.com/naoh_nak 2023年度のアップデート版もあります:https://speakerdeck.com/naohiro_nakata/technicalwriting2023
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは? 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
人材育成 講師派遣研修 公開講座 DX推進 動画教材 通信教育 オンライン研修 オンライン公開講座 オンライン研修一覧 法人向け割引サービス お申込システム WEBinsource スマートパック バリューパック(中堅・成長企業向け) eラン・研修システム 人事サポートシステム Leaf eラーニング/研修システム Leaf eラーニング特化型システム Leaf lightning eラーニング大量配信サービス Leaf inorder eラーニング視聴サービス STUDIO タレントマネジメントシステム Leaf Management / Leaf My STORY 人事評価サービス 人事評価シートWEB化サービス かんたん人事評価システム Leaf Eva 人事・総務・研修担当向けサービス ストレスチェック支援サービス セミナー運営 RPA導入支援サービス IDカードプリンタGRASY
私は企業のIT企画部門の課長としてチームメンバーの文章をチェックしています。また,教育コンサルタントとしてビジネス文章を教えたり,国家試験科目の論文添削をしています。 異なる立場で非常に多くの文章を見てきたので,今では「どんな文章が駄目なのか」がよく分かるようになりました。ここから紹介するのは「よい文章を書く技術」です。 「よい文章」とは「駄目でない文章」 私は人に「よい文章を書くコツは何ですか?」とよく聞かれます。そのときにはいつも,「駄目な文章を書かないようにすることです」と答えています。 人が何をもって「よい文章だ」と感じるかどうかは,極めて主観的なものだと考えています。個人の受け止め方や感じ方に依存する部分が多いからです。 では,ビジネス文書でも「よい文章」を書かなくてはいけないのでしょうか。もちろん,それができるに越したことはありません。 しかし,どんな人でも「うまい」と言わせる
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く