テクニカルライティングの基本
テクニカルライティングの基本を学べます。サイボウズの新入社員向け研修資料です。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 Twitter：https://twitter.com/naoh_nak 2023年度のアップデート版もあります：https://speakerdeck.com/naohiro_nakata/technicalwriting2023
テクニカルライティングの基本を学べます。サイボウズの新入社員向け研修資料です。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 Twitter：https://twitter.com/naoh_nak 2023年度のアップデート版もあります：https://speakerdeck.com/naohiro_nakata/technicalwriting2023
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
社内のプチ発表に使った資料です。 文章のコツ 前置き フルリモートでは、文章でのやり取りがメインになる。 なので、文章がヒドいと「この人と仕事するのキツイ」と思われちゃう😢 そう思われないための色々思ったことを自戒メモ。 なるべく箇条書きにする
私自身、物事を分かりやすく伝えるスキルを身に着けるため、手あたり次第に、いくつかノウハウ本を読んだり、YouTube動画を観たりしてきました。本記事では、本や動画から得られたノウハウや、私が普段の仕事で発見した個人的に使っているテクニックをまとめてみました。 0 本記事の最重要ポイント 本記事がストックの墓場に行ってもいいように、本記事の最重要ポイントだけ先に伝えておきます。 質問に答える時は、聞かれたことにシンプルに答える。 事実と解釈を分けて話す。 1 本記事で伝えたいメッセージ 1-1 コミュニケーション能力の苦手意識はノウハウで解決する ITエンジニアの裾野が広がるにつれて、SNSでも「コミュニケーション能力の低いITエンジニア」の話題をちらほら見かけるようになりました。いわく「これからはITエンジニアにもコミュニケーション能力が求められる」「プログラミングができるだけでは生き残れ
テクニカルライティングの基本を学べます。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 サイボウズの2023年度 新入社員向け研修の資料です。 Twitter：https://twitter.com/naoh_nak 2022年版（初版）：https://speakerdeck.com/naohiro_nakata/technicalwriting
【翻訳】Googleのエンジニアがソフトウェア開発する時に必ず書くドキュメント「Design Docs at Google」 - BppLOG
Googleでの「Design Docs」とは 2007年の Google Developer Day Tokyo での鵜飼氏のプレゼンによると「Google で必ず書くことになっているドキュメント」であり、「プロジェクト立ち上げ時の 1～2週間をかけて書く」ものです。 今回は Google のソフトウェアエンジニアである @cramforce 氏が自身のブログで「Googleでの Design Docs」について解説している記事を公開されていたため、氏の許可を得て翻訳しています。 原文： www.industrialempathy.com 関連書籍： Googleのソフトウェアエンジニアリング ―持続可能なプログラミングを支える技術、文化、プロセス オライリージャパンAmazon 読了目安：11分 (目次) デザインドキュメント の解剖学 文脈と範囲 目標と非目標 実際のデザイン システ
相手に誠実に、わかりやすい文章を書くための心がけをまとめました。 どういう思考プロセスからどんな表現が生まれるのか、参考として実例を紹介しています。実際に読み比べ、SmartHRの従業員として何かを伝えようとするときの、参考にしてください。 伝わる文章のガイドライン何を伝えるかによって、必要な情報の量や説明の粒度は異なります。 情報が不足していたり、逆に情報が多すぎたりすると、読者が意図を読み取れないことがあります。 読み手となる相手の状況（読む場面、事前知識など）を踏まえ、言葉にする内容や表現を厳選することが大切です。 目的に合わせて情報を取捨選択する読者の目線に立ち、コンテンツの目的に合わせて情報を取捨選択しましょう。 実例1：法律や業務に関わる記事目的業務に関係する「厚生年金保険」について正確に知りたいと思っている人に、わかりやすく内容を伝える。 Before日本の年金制度は、全国民
技術文書の書き方
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
ドキュメントに固執せよ - gfnweb
どうして人間集団はこんなにも知見の共有を円滑にできないのか？ 改善にはドキュメントにまつわる各個人の心構え・制度設計・技術的解決の全部が必要だという話をしたい． ここでテーマにしているのは，著名OSSなど世の中にいくらでも知見が転がっている対象ではなく，特に企業内の十数人のチームでクローズドに開発しているなどして集合知に頼れない状況下でのドキュメントについてである． 非常に乱暴な言い方をするなら，「コードとか大部分は誰でも書けるようになるものなんよ，そんなところにマッチョイズムとか感じなくてええねん，我々の知的体力や組織性が真に試されるのはドキュメントちゃうんか」という気持ちです — 画力・博士号・油田 (@bd_gfngfn) June 3, 2022 ドキュメントに書く内容の必須項目或るシステム（ソフトウェアなど）について，そのシステムのことを全く知らない人を想定読者としたドキュメント
社内ドキュメントはなぜ更新されないのか？情報の鮮度を最小限の運用負荷で維持する「イミュータブルドキュメントモデル」のススメ - KAKEHASHI Tech Blog
はじめに こんにちは。カケハシの各プロダクトを支えるプラットフォームシステムの開発チームでテックリードを担当しているkosui(@kosui_me)です。 プロダクト開発の世界では、明瞭な社内向けドキュメントを書くための方法が数多く提案されてきました。読者の中には、製品要求を明瞭にするためにPRD (Product Requirements Document、製品要求仕様書) を書き、プロジェクトの背景から全体の設計やその代案について明瞭にするためにDesign Docsを書き、アーキテクチャに関する意思決定の記録を明瞭にするためにADR(Architecture Decision Record) を書いてきた方も数多くいらっしゃると思います。 しかし、どんな素晴らしいドキュメントも、何故か更新されなくなります。新メンバーへのオンボーディングのためにインフラ構成図を検索したあなたが見つけた
インフラエンジニア向けの書籍を取り上げ、著者と出会い、楽しく本を知り、仲間を作る場所である「インフラエンジニアBooks」。ここで、『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の翻訳を担当した岩瀬氏が登壇。まずは、本書籍の概要について話します。 本セッションの対象者と、セッションのゴール 岩瀬義昌氏：ご紹介いただきました、岩瀬と申します。よろしくお願いします。『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』は、もともと『Docs for Developers: An Engineer’s Field Guide to Technical Writing』という洋書だったんですが、その翻訳をして、今回この機会をいただいています。 余談ですが、APC（株式会社エーピーコミュニケーションズ）さんが「カプセルト
DK @game_sennin 今日も何処かでシナリオライター向けセミナーと講義をしているゴリラ。頼む、どうか許してやってくれ。俺はゴリラなんだ DK @game_sennin ここ数日「地道にやるしかない」みたいな話をし過ぎた気がする。 じゃあ「その地道なことってなんだよ」と考えてみたが、私がすすめるなら、人気作や感銘受けた作品のストーリーを簡潔にまとめる事と、ストーリー構成を抽出することかな。 そうしてインプット、自作にアウトプットする地道な繰り返し。 pic.twitter.com/zYmnXFXnA2 2023-08-01 19:06:37
伝わりやすいスライド資料の作り方。資料作成の流れからデザインのコツ、デザイン初心者さんにおすすめの本まで紹介｜fuyuna blog｜デザイン・ライフスタイル・キャリアについて書くデザイナーのブログ
センスがなくても大丈夫！デザインのコツを活用すれば、だれでも見やすくわかりやすい資料を作成できます。 イマイチな例といい例のスライド見本もご用意しているので、よければ参考にご自身のスライド資料をブラッシュアップしてみてください。 5. フィードバックをもらう資料のデザインが完成したら、上司や先輩に確認してもらいましょう。プレゼン資料は人に見てもらうことを前提として作るため、客観的な意見は重要です。 目的を果たせる資料になっているか内容がわかりやすいかプレゼンを通してどんな印象を受けるかなど意見をもらい、ブラッシュアップをしていきます。 このとき、PDF形式で書き出したものを確認してもらうと、より資料のクオリティが上がります。デザインの現場でもよくあることですが、PDFや印刷した資料を見ると、スライド作成時には気づけなかった誤字や脱字、表現の違和感などに気づけます。 PDFファイルの作成・共
学校で配布された「どくしょかんそう文のかきかた」というプリントが、「私の学生時代もこんなのが欲しかった」「読書感想文ってこういうこと書けばよかったのか」と話題を呼んでいます。 話題になっているのは小学1・2年生向けに配られているプリント。 話題のプリント 冒頭では「よみたい本をえらぼう」と読書感想文のテーマの選び方を指南しており、「のりものやきかいの本」「ものがたりの本」「ゆうめいな人の本（でんき）」「どうぶつやしぜんの本」と4つのジャンルの魅力を紹介しています。。 続く「どくしょかんそう文のくみたてを考えよう」では、「本をえらんだわけ」「あらすじ」「こころにのこったところ」「じぶんだったらどうするか」と順序だてて感想文を書く方法をアドバイス。具体的な例を出しながらの説明は年齢を問わず、わかりやすい内容となっています。 このプリントを紹介したのはTwitterユーザーの小麦こむぎ子（@co
こんにちは。壮（@sew_sou19）と申します。 メガベンチャー企業でエンジニアとして働いています。 エンジニアにジョブチェンジした当初は、ドキュメントの書き方なんてこれっぽっちも分かりませんでした。読みやすいドキュメントを書くことが本当に苦痛だったのですが、考えて、試行錯誤し続けた結果、以下のような評価を得るに至りました。 リーダーから「君は情報の整理が上手でドキュメントが本当に読みやすい。チーム全体の能力向上に繋げたいからドキュメント書く際のポイント共有してほしい」と言われたので、意識していることを言語化しつつテクニカルライティングの本でインプットしてるけど、学びが多い。ついでにnoteにもまとめてる — 壮 (@sew_sou19) November 28, 2022 そこでこのnoteでは、僕がドキュメントを作成するときに、特に意識して実践している7つのことを書きます。（本当は2
手順書フォーマットは千差万別 みなさんは自己流または、組織やプロジェクトで定められた手順書のフォーマットはありますか? 私は自己流の手順書フォーマットがあります。 自己流の手順書フォーマットがあるといっても、かなり扱いがふわふわしているので、備忘やメモの意味合い強めでまとめていきます。 「もっとこうした方がいいよ!!」などフィードバックがあれば、ぜひお願いします! いきなりまとめ 手順書はExcelやスプレッドシートではなく、Markdownで書く 手順書はgitで管理する 5W1Hを意識して手順書を書く 基本的にはCLIを使った手順書にする 手順書はExcelやスプレッドシートではなく、Markdownで書く 手順書をExcelやスプレッドシートで書くメリット・デメリット 手順書をExcelやスプレッドシートで書いている方も多いと思いますが、私はMarkdownで書いています。 Exce
「という」と「こと」を削って文章のもたつきをとる【WEB文章術】 | センスも文才もなくていい 発信力を上げる「WEB文章術」 | mi-mollet（ミモレ） | 明日の私へ、小さな一歩！（1/2）
ミモレで2021年に公開された記事のうち、特に人気があったものをご紹介します。よろしければぜひご一読ください。 無意識に使ってしまいがちで、“文章のもたつき”を生む言葉に「という」と「こと」があります。「という」と「こと」を減らし、言い換えるコツをご紹介します。 「という」はなくても成立することが多い 話し言葉に近い文体で書くブログやWEB記事は、普段の口グセ・言い回しのクセがそのまま文章に出やすいですよね。前回ご紹介した「のですが」同様、「という」も、無意識にクッション言葉として使いがちです。私自身もインタビューの録音をテープ起こしのために聞くと、「〜なんですが」と「〜という」「〜っていう」を多用していることに気づいて反省します。 「〜のですが」や「という」「ということ」など、話し言葉では語気をやわらげるクッション言葉も、文字として連続するとより目障りでまどろっこしい印象に。私はこれを「
東京・立川を拠点に起業に関連したさまざまなイベントを開催しているStartup Hub Tokyo TAMA。本記事では、『秒で使えるパワポ術』『秒で伝わるパワポ術』の著者で、シリョサク株式会社代表の豊間根青地氏が登壇したイベントの様子をお届けします。今回は、スライドの本質や、スライドを見やすくするポイントについて語られました。 前回の記事はこちら スライドの本質 豊間根青地氏（以下、豊間根）：あと2つですね。「構造を図解にする」という話をしていきます。ここでお話しするのは、要はタイトルとキーメッセージが作れましたと。そのスライドで答えは決まったんだけど、じゃあその根拠・理由をどう作るかというところの考え方をお話しします。 いわゆるスライドの中に載せるコンテンツ、図表の話をしていくわけですが、最初に意識いただきたいのは、みなさんがパワポのスライドをどういうイメージで捉えるかという話です。
5秒のことを200字かけて書く～古賀さんの日記の書き方
デイリーポータルZ読者にはおなじみの古賀テンションだが、日記本で古賀さんを知った人にはこのテンションで良いのか不安になる。 だって本ではこんな感じである。 昼は私も娘も各自好きに食べ、午後リモートでうちあわせをしているうちに娘は作文教室へ行った。 PCのファンの音がとまり、IHコンロのファンの音もとまり、私以外には誰もおらず、すると一気に静かになった。うるさく感じていたわけでもなかった音がやむ、その瞬間の雰囲気が好きだ。 （「ちょっと踊ったりすぐにかけだす」 p.236） 生活のなかの一瞬を描写している。 この日記の書き方を習うために散歩してその様子を書くことにしたい。習うのは林。編集部の橋田さんにも話し相手として散歩に同行してもらった。 まずは散歩の様子をいつものデイリーポータルZ風にざざっと記し、そのようすを古賀・林がどのように日記にするかを検証したい。 まずはいつものデイリーポータル
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
質の高い技術文書を書く方法 - As a Futurist...
フルリモートで相手に気持ちよく仕事をしてもらうためのコツあれこれ
「何を言っているのか分からない」と言われないための「伝え方」のノウハウ - Qiita
テクニカルライティングの基本 2023年版
伝わる文章 | 基本要素 | SmartHR Design System
「ドキュメントの書き方」を体系的に学んだことがないエンジニアへ 書籍『エンジニアのためのドキュメントライティング』の概要
講師がオススメする「作家を目指す際に地道にやるべき訓練方法」が納得が深い そこに至るまでの「なぜ地道にするしかないか」も
小学生に読書感想文の書き方教えるテンプレが最高にわかりやすい 学生時代に「欲しかった」と2万“いいね”
読みやすいドキュメントを書くために今日からできる7つのこと｜壮｜Masato Tanaka
自己流の手順書フォーマットを公開してみた | DevelopersIO
文章が3行以上続くパワポ資料は読まれない まず全体像が伝わる、拾い読みできる提案資料の作り方