• Twitterでシェア
  • Facebookでシェア

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

テクノロジー カテゴリーの変更を依頼 記事元:blog.riywo.com
適切な情報に変更
2009users がブックマーク コメント 103
    共有

    • 記事へのコメント103件

    • 注目コメント
    • 新着コメント
    その他
    オーナーコメントを固定しています
    riywo
    オーナー 書いてみた

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

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

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

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

    その他
    KullbackLeibler
    長い

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

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

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

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

    その他
    オーナーコメントを固定しています
    riywo
    オーナー riywo 書いてみた

    2021/01/27 リンク

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

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

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

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

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

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

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

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

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

    その他
    mura-_-mi
    大事

    その他
    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

    その他
    kiririmode
    working backward

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

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

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

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

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

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

    その他
    kazoo_oo
    とてもよい。

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

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

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

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

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

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

    その他
    iekusup
    ほー。

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

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

    その他
    halfrack
    むっちゃいい内容

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

    その他

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

    アプリのスクリーンショット
    いまの話題をアプリでチェック！
    • バナー広告なし
    • ミュート機能あり
    • ダークモード搭載
    アプリをダウンロード

    関連記事

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

    大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は...

    ブックマークしたユーザー

    すべてのユーザーの
    詳細を表示します

    同じサイトの新着

    同じサイトの新着をもっと読む

    いま人気の記事

    いま人気の記事をもっと読む

    いま人気の記事 - テクノロジー

    いま人気の記事 - テクノロジーをもっと読む

    新着記事 - テクノロジー

    新着記事 - テクノロジーをもっと読む

    同時期にブックマークされた記事

    いま人気の記事 - 企業メディア

    企業メディアをもっと読む

    はてなブックマーク

    公式Twitter

    はてなのサービス

    • App Storeからダウンロード
    • Google Playで手に入れよう
    Copyright © 2005-2025 Hatena. All Rights Reserved.