継続的にアウトプットするための文章術 - takanorip blog
継続的にアウトプットするために考えていること。 対象読者を無視する 書きたいことを書けば良い。「対象読者：自分」くらいの気持ちで書く。「こんな記事誰が読むんだろう…」みたいな気持ちは捨てる。 自分にとっては些細なことでも、その情報を欲している人はたくさんいるかもしれない。公開してみないとそんなのわからん。とりあえず書いて公開する、それが一番重要。 誰に読まれるかより、誰に読まれたかを分析するほうが大事。継続して分析することで、どんな記事がどんな属性の人に読まれやすいかわかってくる。 間違ったことを書くことを恐れない 間違ったことを書いても良いというわけではないが、人間なので100%正しいことを書くことはとても難しい。労力も時間もかかる。その分情報の新鮮さはなくなっていく。 無料で読める記事なので多少の間違いは仕方ない、注意されたり気づいたら修正すれば良い。何事も諦めが肝心。 目次（アウトラ
読みやすいドキュメントを書くために今日からできる7つのこと｜壮｜Masato Tanaka
こんにちは。壮（@sew_sou19）と申します。 メガベンチャー企業でエンジニアとして働いています。 エンジニアにジョブチェンジした当初は、ドキュメントの書き方なんてこれっぽっちも分かりませんでした。読みやすいドキュメントを書くことが本当に苦痛だったのですが、考えて、試行錯誤し続けた結果、以下のような評価を得るに至りました。 リーダーから「君は情報の整理が上手でドキュメントが本当に読みやすい。チーム全体の能力向上に繋げたいからドキュメント書く際のポイント共有してほしい」と言われたので、意識していることを言語化しつつテクニカルライティングの本でインプットしてるけど、学びが多い。ついでにnoteにもまとめてる — 壮 (@sew_sou19) November 28, 2022 そこでこのnoteでは、僕がドキュメントを作成するときに、特に意識して実践している7つのことを書きます。（本当は2
伝わる文章作成の基本を学ぶための記事・学習コンテンツのまとめ - Qiita
短いメッセージを書くことはできても、まとまった文章を書くのに苦労している人は多いのではないでしょうか。 この記事では、まとまった文章を作るときの技術を学ぶことができる記事や学習コンテンツを紹介します。新人エンジニア向けです。 文章の「型」を学ぶ まとまった文章を書くには、「型」が必要です。頻繁に使うものは、「型」を覚えてしまいしましょう。 バグレポートの書き方を学ぶ エンジニアとして書く文章の代表例が、バグレポートです。 バグレポートでありがちな失敗として「何が問題だと思っているのか」が伝わらないというものがあります。 これを防ぐために、「期待する結果」「実際の結果」「再現手順」の3つを必ず書くようにしましょう。 質問の書き方を学ぶ エンジニアが扱う技術は、最初はわからないことだらけです。 それを解決するために、質問の文章を作成する技術が必要となります。 概ね下記の4つの情報があれば、良い
実践テクニカルライティング - 開発者が「外国語」を使うときの言語技術達3つ - Qiita
言語技術 というものをご存知でしょうか。 言語技術とは、思考を論理的に組み立て、相手が理解できる様に分かりやすく表現すること。 人前で話す能力や議論の能力、文章を書く能力や論文を書く能力はトレーニングによって身につけられる。我々開発者にとっても、普段の語彙に距離のある相手、たとえば非技術者との会話の際にこの言語技術を意識することがキーになる。記事のタイトルは「外国語」と書いたが、英語は勿論、開発者にとって顧客や非技術者は時として「外国人」。開発者にとって、例えば 英語学習 テクニカルサポートのやり取り の時等に使える、情報を整理する言語技術とツールについて、3つのトピックからまとめた。 『外国語を身につけるための日本語レッスン』に学ぶ、言語技術 『情報を整理するたった5つの方法 LATCH』 Google Sheets 等で、「外国語」を使う相手と状況共有をうまくする仕掛け 1. 『外国語
箇条書きより見出しを好め - koicの日記
Wiki や esa なんかでひたすら箇条書きで記されているのを、最近たびたび見かけるようになった気がしたので話していた、文書構造のリファクタリングテクニックとなる。 基本は一番浅い箇条書きを大見出しにして、ネストを一段ずつ下げるといったものでざっくり以下のような図解で話していた。以下の例では大見出しになったものをタイトルとしており、中見出しが一番浅い箇条に対応している。初手としてはかなり手早く手を加えることのできるテクニックのひとつだと思う。 もちろん箇条書きが良くないといったものではなく箇条として成立していればよい。良くないのは箇条の重ね書きの結果として、箇条書きの4段ネストといったものなどで、それは既に箇条として破綻していたりする。そういった structure smell を作らないように積極的に見出しを導入しておくのがひとつの解だと思っている。 広く普及していると思われる Mar
質の高い技術文書を書く方法 - As a Futurist...
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
技術的な文章を書くための1歩、2歩、3歩 - Qiita
ちょっと書きたくなったので書くんじゃーい！ この文章を読み終わった時、読者がそれなりわかめ品質な文章を出力できるようになり、どこかに寄稿した時に全面リテイクを食らったりしないようになることを目指します。 mhidaka が 0歩目を書いてくれました！ 背景 筆者は普通のエンジニアです。その辺の開発とかしてる会社に勤めています。技術系の原稿も書きます。 原稿書きでご飯食べてるわけではありません(晩ご飯が豪華になることは稀にあります)。 今まで有能なレビューワー(muなんとかさんとか)編集さんとか(某社の安藤さんとか)とかとかに鍛えていただきました。 この場を借りてお礼を述べておきたいと思います。ありがとうございます。 なお、この文章は2013年10月時点での筆者(わかめ)のやり方です。 将来的にはより良いやり方を見つけるでしょうし、これとは全く違う書き方で上手にやっている人もいると思います。
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
テクニカルライティングの基本