テクノロジー
質の高い技術文書を書く方法 - As a Futurist...

気に入った記事をブックマーク

気に入った記事を保存できます
保存した記事の一覧は、はてなブックマークで確認・編集ができます
記事を読んだ感想やメモを書き残せます
非公開でブックマークすることもできます

質の高い技術文書を書く方法 - As a Futurist...

テクノロジーカテゴリーの変更を依頼記事元:

blog.riywo.com

適切な情報に変更

エントリーの編集

エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。

このページのオーナーなので以下のアクションを実行できます

タイトル、本文などの情報を
再取得することができます

コメントを非表示にできますコメント表示の設定

ブックマークしました

ここにツイート内容が記載されますhttps://b.hatena.ne.jp/URLはspanで囲んでください

Twitterで共有

次回からTwitterへ自動リダイレクト

ONにすると、次回以降このダイアログを飛ばしてTwitterに遷移します

2009usersがブックマークコメント

103

コメントするにはログインが必要ですブックマークを追加

ブックマークを追加

よく使うタグ

質の高い技術文書を書く方法 - As a Futurist...

2009 users

blog.riywo.com

よく使うタグ

はてなブックマークで
関心をシェアしよう

みんなの興味と感想が集まることで
新しい発見や、深堀りがもっと楽しく

ユーザー登録

アカウントをお持ちの方はログインページへ

記事へのコメント103件

注目コメント
新着コメント

オーナーコメントを固定しています

オーナーriywo書いてみた

2021/01/27リンク

その他

tettekete37564文書の最も簡潔なオーバービューというのは目次になる。そして目次は箇条書きのネストになる。情報の構成概要を表したり、その要素を列挙するならば箇条書きを忌避する理由はない。特に条件や要件の列挙など

2021/01/28リンク

その他

non_117箇条書きをネストしたやつ人に読ませるものではないよね

2021/01/28リンク

その他

unique120この文章を読んでも、よく意味がわからないのですが。

2021/01/28リンク

その他

baca-aho-dojiめちゃめちゃいい文章。仕事の質を上げるのに必要なことがたくさん書いてある。これを自分がやれてるかっていうとやれてないなと思うことが多いので改めて見つめ直したい。

2021/01/28リンク

その他

KullbackLeibler長い

2021/01/28リンク

その他

tossy_yukky言ってることは正しいと思うけど、ネット上にある文章としては体裁が本に寄りすぎてる感。

2021/01/28リンク

その他

nWY2RhxQPXKQloX3z異様に一文が長かったり、「これは」「その」「それ」「こうした」などの指示語が多い印象を受ける。

2021/01/28リンク

その他

table読み手の質に合わせる事が一番大事

2021/01/28リンク

その他

jmako長すぎて最後まで読む気にならなかったw 最初の三行で重要なことのみ書いとけよ！！

2021/01/28リンク

その他

オーナーコメントを固定しています

オーナーriywo書いてみた

2021/01/27リンク

その他

Casseroles“が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。”

2024/03/05リンク

その他

lycolia人に説明しやすい質の高い文章の書き方について

2024/01/16リンク

その他

takatamaAmazon流。結論から書こうとすれば、結果的に考え抜いた文書になる。周囲に優れた文書があふれていると、自分のレベルも上げやすい

2023/09/15リンク

その他

Kazumi007ドキュメントは難しいよね

2023/03/04リンク

その他

tjmschk社内の文章をつくるためにお勧めされて読んだけど、すでに猛スピードで書き上げてからロクに見直してないアドカレをもう書き直したくなってきている。

文章

2021/12/10リンク

その他

ymgnこのあたりちゃんと守れてたらいいドキュメントとかアジェンダとか作れそうだ

2021/04/21リンク

その他

cupeytan”この文書を初めから最後まで読んだ人は一体どんな情報を得られるのか？ということを文書を書く前に決めるのだ。“

2021/04/21リンク

その他

sugoi_wada“文書から得られるアウトプットが明確で、読み手のレベルによらず一定に伝わること”

2021/03/13リンク

その他

king-masashi文書を書く時の参考にさせていただきます。

2021/03/13リンク

その他

mura-_-mi大事

2021/03/10リンク

その他

yunohito/72438b38f545fac8ca9133502d178901/bef64/riywo.webp 100w, /static/72438b38f545fac8ca9133502d178901/9e195/riywo.webp 200w, /static/72438b38f545fac8ca9133502d178901/5ba9d/riywo.webp 300w, /static/72438b38f545fac8ca9133502d178901/23b25/riywo.webp 367w" sizes="(max-width: 200px) 100vw, 200px" /><source s

2021/03/03リンク

その他

kiririmodeworking backward

document

2021/02/12リンク

その他

gadgeterkun何度も読み返したいブログ

2021/02/10リンク

その他

Sixeight読み手を意識してない箇条書きをしがち。。。文章苦手なので練習しよう。

2021/01/30リンク

その他

tookikimie「決断を下したいのであれば、1 つの選択肢を第一候補として、何も異論がなければそのまま、そうでなければ理由を添えて別の選択肢へ、という進行にした方が合意を取りやすい。」

2021/01/30リンク

その他

braitomすごくよかった。定期的に読み直したい。"文書から得られるアウトプットが明確で、読み手のレベルによらず一定に伝わること"

2021/01/30リンク

その他

d4-1977「文書を作る過程に於いて一貫して「アウトプットがなんなのか？」を問い続けることが最も大切なこと」🙇🏻‍♂️ワカル。ムズカシイ

2021/01/30リンク

その他

mohri「箇条書きは短文で済むので文書を速く仕上げることができる一方で、行間を読むことを読み手に強制する」

2021/01/29リンク

その他

kazoo_ooとてもよい。

2021/01/29リンク

その他

Tomosugiこの場合の技術文書はtechnical documentの訳だと思うが、実務文書のほうがしっくりくる

文章

2021/01/29リンク

その他

ktmtto研究概要を人（専門/専門外理系/専門外文系）に説明するための文書を書くときに参考にする

2021/01/29リンク

その他

zigzag1900いくらその技術があっても、そういう文化でないとそっちに淘汰されてしまう。

2021/01/28リンク

その他

wyukawaわかる。が、自分が出来ているかというと。。。

文章

2021/01/28リンク

その他

iwasiman長いけどなんか凄く良いガイドがキタ！人に読ませる文書を心掛けたいものです。

技術

2021/01/28リンク

その他

koji28「文書の目的を最初に完結に書くと…文書の期待値を大まかにコントロールできる」読み手の期待値をコントロールする…かぁ(´・ω・`)

2021/01/28リンク

その他

iekusupほー。

2021/01/28リンク

その他

yuki_2021最初に結論を書くということ。論文とかでも使われる考え方だね。

2021/01/28リンク

その他

iwanofskyハウツーを読んだからどうかではない。読んで実践し自ら振り返るか、または他者から指摘を受け、次実践あるのみ。書いた数が多いと高くなるわけでもない。どう変えたことによって、どのような反響や効果が出たか？

2021/01/28リンク

その他

$halfrack$

halfrackむっちゃいい内容

2021/01/28リンク

その他

showiiこれでも長すぎて読んでる人少ないのでは？

2021/01/28リンク

その他

コメントするにはログインが必要ですログインしてコメント

注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています

リンクを埋め込む

以下のコードをコピーしてサイトに埋め込むことができます

プレビュー

はてなブックマークボタンを作成して埋め込むこともできます

規約違反を報告

いまの話題をアプリでチェック！

バナー広告なし
ミュート機能あり
ダークモード搭載

アプリをダウンロード

usersに達しました！

さんが1番目にブックマークした記事「質の高い技術文書...」が注目されています。

気持ちをシェアしよう

ツイートする

質の高い技術文書を書く方法 - As a Futurist...

大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は...大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近はAmazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。そもそも文書とは？英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料会議の叩き台となる 1 枚ペラ本番環境に変更を加えるにあたっての包括的な情報や具体