開発ドキュメントの書き方！9つのコツ【エンジニア】
文章を書く前にやることよい文章を書くには、実際に文章を書く前に、読者は誰か、どういう悩みを解決するのかを企画することが大切です。また、それを元にアウトラインを書いておきます。 このふたつを元に文章を書くことで、読みやすい開発ドキュメントにつながります。これについては、次の記事をご覧ください。 開発ドキュメントを書く前に決めるべき3つのこと【企画編】開発ドキュメントにおけるアウトラインの書き方開発ドキュメントの書き方企画とアウトラインの作成が終わったら、実際に文章を書いていきます。文章を書くときは、次の9つを意識して書きます。これだけで、読みやすさ、分かりやすさが大きく向上します。 一文を短く切る結論を先に述べる指示語を使わない主語を明確にする、述語との距離を近づけるひらく・閉じるを統一する再現条件を示す前提を揃える見出しや箇条書き、表などを適切に用いる読者に伝わる用語を使うひとつずつ説明し
記事・文章を編集する時に気をつけたい7つの基本事項チェックリスト | 株式会社LIG(リグ)｜DX支援・システム開発・Web制作
ども、メディア事業部のゆうせいです。最近はありがたいことに他メディアでも露出が増えてきましたが、普段の業務は記事の編集です。 今回は、記事、つまり文章を編集する時に気をつけていることの中から、7つをご紹介したいと思います。とは言え、細かいことや小難しいことを言うつもりは全くありませんので、お気軽にお読みください。 文章を編集するときに気をつけている7つの基本事項 1. 言いたいことは見出しで書く はい、もう言いたいことは言いました。読んで字の如し、言いたいことは見出しに書く。文章の一言一句を読んでくださるのは、校正担当の方か、よほどの文字マニアだけだと思ってます。（だからと言って誤字脱字はダメ絶対） まずは見出しを読み、興味が無ければ読み飛ばす。これは至って普通のことで、皆同じ。だから、段落の文章を全部読み飛ばされたとしても、最低限これだけは分かってくれ！俺の気持ちを受け取ってくれ！と懇願
フォントやレイアウトで人にいい印象を与え好意的に文章を読んでもらう方法
画像や文章のレイアウトはウェブサイトをデザインする時だけではなく、資料やポスターなどを作成する時にも必要になりますが、正しいフォントの選択やレイアウトは文章を読みやすくするのに加えて、人の脳に作用し読み手を心地よくさせます。ということで、以前記事化した「自分のアイデアをアプリ化するための予算を自動計算してくれるウェブサービス『How Much Does It Cost To Make An App？』」を提供しているooomfの創設者・Mikael Choさんが、すぐにでもできる効果的な文書の作成方法をまとめています。 The science behind fonts (and how they make you feel) | ooomf blog https://ooomf.com/blog/the-science-behind-fonts-and-how-they-make-you-
ブログのネタはどこからやってくるのか？－読書猿ブログの７つの源泉
使いまわす／前に書いた記事の残り １０調べても、使うのはそのうち１～２。残りの８～９の中にまだ使いたいネタがあって、それを使う場合。 これが一番速い。連投できるが、面白いものから書いていくから、尻すぼみになる。 長期的に見ると、残り物を書かずに残しておいた方が、他と結びついたり育ったりして、ましなものになりやすい。 先に進む／前に書いた記事の続き 前項とは似て非なる。 ある記事を書いたことがきっかけになって、その前には至っていなかったところに進めた場合。 しかし、こちらは時間はかかる。 たとえば、「書評を読むな、書誌を読め／存在すら知らぬ本を探すための本 」（2010.11.16）という記事をきっかけにして、「点の読書、線の読書、面の読書 」（2011.02.27）という記事を書いたけれど、この時点では単なる抽象論だった。 図書館の使い方についてのいくつかの記事や、「集めた文献をどう整理す
「自分の書く文章は価値がない」を抜け出すライティング・マラソンという方法←自己検閲を振り切って書きなぐるために
ものを書く人は自由人である（少なくともそうありたいと思っている）から、 これは書くことがとことん苦手な人のために書いた文章です→小学生から大人まで使える素敵な方法 読書猿Classic: between / beyond readers のような型（かた）の話をすると結構反発を食らう。 すでに書いている人たち向けに書かれたものでは、たとえば 書きなぐれ、そのあとレヴィ＝ストロースのように推敲しよう／書き物をしていて煮詰まっている人へ 読書猿Classic: between / beyond readers のような記事がある。 しかしレヴィ・ストロースのようにはできないという声も寄せられる。 何より、立ち止まらず振り返らず、ただ書きなぐっていくのが難しい。 心の隅から湧き上がる自己検閲の声はしばしば、書きなぐる速度よりも速く、我々をつかまえてしまう。 「本当にそうなのか？」 「そう言い切れ
推敲なし即アップでも破綻しない文章を書くTipsとか - インターネットの備忘録
先週のイベント以降、推敲なし書いて即記事投稿をやってみる人が散見されて、あれは意見の裏打ちをしたり整合性とったりしないで記事を量産するためのテクニックであって、文章がうまくなるためのテクニックじゃないよなーって思ってたのですが、色んなひとがブログ書けば楽しいのにって思ってるので「とりあえず書いてみよう！」と思う人が増えたのはとっても嬉しいことです。 3月からこっちなるべく毎日記事を書こうと思ってがんばってきて、がんばっただけPVも上がってきている矢先に、急に忙しくなってきて文章を書くのがお留守になってしまいました。 某氏にならってわたしもなるべく効率よく記事を書けるようになりたいなーって反省しているので、早く、かつ、読んだ人が「何言ってんだコイツ」になることをなるべく避けて、意味の通る文章を書くためのTipsを備忘しておきます。 起承転結 起＝物事に対して思ったこと 承＝そのことに対する自
文章に向いてない構造をいかに文章に向いた構造に直列化するかが大事 - きしだのHatena
Software Design 12月号の特集が「なぜエンジニアは文章が下手なのか？」というタイトルだったので、読んでみたら、ちょっと残念な内容だった。 「それは文章で書くべき情報なのか」という章があって、直列化した論理構造であれば文章には書きやすいけど、分岐やループがあるような構造だと書きにくいということが書いてあった。そこで文章化しにくい構造の例として地図があげてあって、暗にそういう構造は文章化をやめて図であらわせと言っているように読める。 けれども、図に書いたところで、書く側は文章化から逃げれて満足かもしれないけど、それを読み取る側は結局どこかから順番に解釈していく必要がある。図に逃げるのは、読み手に責任を押し付けているだけだと思う。 で、「ですから文章を書く前にまず論理構造を考える必要があります」と続いていて、では考えた論理構造が「文章に向かない論理構造」だったらどうするの？逃げる
反応が取れるブログの書き方〜たった4つの基本文章テクニック〜
１．マクスウェル・サックハイムの三原則マクスウェル・サックハイムは１９００年代前半に活躍した敏腕広告マンだ。広告業界、コピーライティング業界に大きな影響を与え、マクスウェル・サックハイム賞という賞も出来ている。受賞者には、例えば「滑り台効果」で有名なジョー・シュガーマンがいる。 さて、マクスウェル・サックハイムの三原則とは以下のようなものだ。 この三原則は、広告/コピーの業界にいる人間なら、誰もが知っているほど有名なものだ。そして、優れた文章には、この三原則を乗り越える力がある。 それでは、この三原則を乗り越える文章を書くには、どうすれば良いのか？一つずつご紹介する。 １−１．Not Read（見ない）を乗り越える方法Not Readを乗り越えるためには、一目で中身を読み進めたいと思ってもらえるようなキャッチコピーが必要だ。ここでいうキャッチコピーとは、ブログならブログタイトル、メールなら
デザインが優れている人には愛情と思いやりがあるという話｜資料やメールも全てがデザイン
Word資料など、10年前にはよく作っていた時に、先輩から教わった話。 「デザインの仕事しているのに、文章がとてつもなくわかりにくいね君」から会話がスタートした。 は？なんで文章なのにデザイン関係あるの？ デザインはレイアウト、見た目、イラストと言ったものだけではない 最近、Webデザイナーの初心者さんからの質問で 「デザインのセンスはやっぱりデザインの基礎から学ばなければいけませんよね。綺麗なWebデザインを作るためにはレイアウトとか配色とか比率とか、あと絵ももっと勉強を・・・」 これを聞いた時、どこかに違和感を覚えた。 うーん？ しばらくして思い出した。そういえば昔先輩に教わった覚えがあるなと。 当時私は新聞の折込広告などの作成を行なっていました。その時の企画提案書を先輩に確認してもらった時の事。 「デザインの仕事しているのに、文章がとてつもなくわかりにくいね君。デザインとは相手を思い
驚くほど違う→あなたの文章を最適化するたった４つのルール
文のレベルで、日本語を明確化する工夫について取り上げた著作には、本多勝一(1982)『日本語の作文技術 (朝日文庫)』（朝日文庫）があるが、酒井聡樹(2007)『これからレポート・卒論を書く若者のために』（共立出版）が、さらなる改良に取り組んでいる。 この記事は、両著作についての私的メモの域を出ない。 なお『これからレポート・卒論を書く若者のために』は、井上真琴『図書館に訊け!』(ちくま新書)とともに、大学新入生のマストアイテム。入学する前に読んでおくと、まるでちがった４年間を過ごせるだろう。 以下では、まず日本語の文がわかりにくくなる４大原因を示し、次に４大原因のそれぞれに対応した４つの最適化ルールを提示する。最後に、それぞれのルールについて適用例を挙げて、ルールの活用法を説明する。 文が分かりにくくなる４大原因 １．一つの文に多くの情報が詰め込まれている ２．情報を与える順番がおかしい
サービス終了のお知らせ - NAVER まとめ
サービス終了のお知らせ NAVERまとめは2020年9月30日をもちましてサービス終了いたしました。 約11年間、NAVERまとめをご利用・ご愛顧いただき誠にありがとうございました。
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
