エンジニア歴20数年の私が、設計書を書く際に心がけていること - Qiita
はじめに 時の経つのは早いもので、私がIT業界に身を置いて四半世紀になってしまいました。 その間、膨大な数の「設計書（仕様書）」を書いて来ましたが、未だに悩み・迷いは尽きません。 それでも、亀の甲より年の劫とも申しますので、私なりの経験則を「個人」と「チーム」の両観点でまとめてみました。 本稿のテーマは、「主に設計書を想定した、開発ドキュメントの書き方」です。 本稿で前提とする設計書は、ExcelやWordで書かれた、フォーマルな（≒納品物になりえる）設計文書、です。 したがって、自社サービス開発よりも受託開発、アジャイルよりもウォーターフォール、を前提として読んでいただいた方が、しっくりくると思われます。 ＜ご注意＞ 本稿の内容は執筆者独自の見解であり、所属企業における立場、戦略、意見を代表するものではありません。 個人的に心がけていること 当該文書の作成目的や位置付けを冒頭に記載する
漢字とひらがなを使い分ける（文章を書く心がけ）｜結城浩
こんにちは、結城浩です。 この「文章を書く心がけ」のコーナーでは、文章を書くときに心がけたほうがよいことをピックアップしてご紹介します。 このページをお読みのみなさんの中には、文章を書き慣れていない方から、文章を書くプロの方まで、いろんな方がいらっしゃいます。 ですから、教科書的に一歩一歩進むような内容ではなく、結城が普段気をつけていることを中心にさまざまなトピックをお話ししようと思います。 さて、今日は「漢字とひらがなの使い分け」というお話をしましょう。 結城はときどき、他人の文章を校正することがあるのですが、そのときに思うのは、 文章に慣れていない人ほど漢字を多用してしまう ということです。 たとえば、あなたなら次のどちらを使いますか。 「事」と「こと」 「時」と「とき」 「訳」と「わけ」 専門的な文章で表記法が定まっている場合は別として、通常のメールやブログでの文章では、一般的にいっ
文章を読みやすくする効果的な３つの工夫 - 経済的独立を目指して
2014-03-23 文章を読みやすくする効果的な３つの工夫 一つの段落では内容を一つに絞る 文法的に間違いのない、理路整然とした文章でも、一読して中身が頭に入ってこない文章があります。 それは一つの段落が長く、かつ複数の要素があるケースです。 そもそも段落というのは、一つ意味、つまり言いたいことのかたまりです。その一つの意味を説明するためにいくつかの分が集まっています。そういう段落に、二つも三つも意味を盛り込もうとすると、読み手は混乱してしまいます。 一つの段落では、触れる内容を一つだけにとどめるように注意したいところです。 また、全体の文章が長くなるときは、改行するだけでなく、一行空けるだけで読みやすくなります。 段落の最初に「さわり」を見せる 分かりやすい文章を書くためには、あらかじめ読み手にこれから何について書こうとしているのかを伝えておくのも有効な方法です。これから読も
書く力を本当に倍増する、容易くはない５つのトレーニング
書くことはどのようにして学ぶことが、いや鍛えることができるのか？ 書くことによって、というのが唯一正しい答えである。 書くのが苦手な人は書くことをできるかぎり回避する。そうして苦手意識をつのらせる。さらに書くことを回避する。この悪循環を断ち切るには、嫌でも書くしかない。 対して、書くことを楽しむ人は、放っておいても何か書く。書き続ける。 アメリカのミステリー作家ローレンス・ブロックは、Writing Digest誌の連載コラムで、最悪の長編小説を３つ書き上げた男の症例を紹介している。 最初の１篇は、ブロックが最大限の親切心を動員しても一句たりとも良いところがない、それどころか直すことさえ不可能なくらいひどかった。なのに男は次の本を書き始めた。 完成した２つめも最悪といっていい出来だったが、１作目を知る数少ない人たちには大きな改善が感じられた。男はまた次の本を書き始め、書き終えた。 これまた
これは書くことがとことん苦手な人のために書いた文章です→小学生から大人まで使える素敵な方法
忙しい人のための要約 以下の５つのパートで文章を構成する。 Ａ．〈はじめ〉 ……内容の紹介・要約 Ｂ１．〈なか１〉 ……具体例その１ Ｂ２．〈なか２〉 ……具体例その２ Ｃ．〈まとめ〉 ……具体例の共通点 Ｄ．〈むすび〉 ……上記の共通点の一般化〈としての主張〉 書く順序は次の通り。 １．具体例をあつめる→〈なか１〉〈なか２〉 ２．具体例の共通点を書く→〈まとめ〉 ３．まとめから言えること（主張〉を書く→〈むすび〉 ４．内容を簡単に紹介する入口を書く→〈はじめ〉 （ほかに参考になりそうな記事） ・文章の型稽古→穴埋めすれば誰でも書ける魔法の文章テンプレート 読書猿Classic: between / beyond readers ・物事を論じられるようになるスモール・ステップス→米国の小学生が使う思考ツール 読書猿Classic: between / beyond readers 書くこと
テキストのメリハリをつける方法7つ
私のデザイン修正で一番多い指示が、「メリハリをつけてください」で、以前はどうすれば良いかわからず困っておりました…。(今も時々わからなくなりますが…) 最近ようやくどうすればメリハリがつくかわかってきたので、その方法をまとめてみました。 「メリハリをつけてください」の修正意図は、目立つべきところが目立っていないので、重要な部分を視覚的にはっきりさせてください、ということだと思います。 例として、以下のような見出しとテキストをもとに考えてみます。 （メリハリをつける場合、サイト全体のバランスをみてつけることが必要ですが、ここではわかりやすくするため、見出しと説明文のみで考えています） （引用：Wikipedia: カメラ http://ja.wikipedia.org/wiki/%E3%82%AB%E3%83%A1%E3%83%A9） 私の場合、メリハリをつけるのは以下7つの方法が多いです。
読みやすい文章を書くのに押さえておきたい基本となる5つのポイント
ブログに限った話ではないですが、読まれることを前提に文章を書くのは何かを伝えるためです。読みやすい文章を心がけることで、読み手への伝わり方が全く違ってきます。 今回はそのために押さえておきたい、読みやすい文章のポイントについてまとめてみました。 一般的になじみのない言葉は使わない Photo:Fountain pen, cheap By realblades 伝えることを目的とした文章には、理解しやすい言葉や単語を選ぶべきです。 読みが難しい漢字が入っていたり、普段めったに使わないビジネス用語が文章の中にずらずらっと並んでいたりすると、読み手にとっては苦痛でしかありません。 特定分野の限定層を対象とした媒体であれば、それに関連する専門用語を多用するほうがより伝わると思いますが、分野を問わず広く読んでもらいたい内容であれば、どんな人にもわかる言葉や単語を用いることをおすすめします。 もし専門
サービス終了のお知らせ - NAVER まとめ
サービス終了のお知らせ NAVERまとめは2020年9月30日をもちましてサービス終了いたしました。 約11年間、NAVERまとめをご利用・ご愛顧いただき誠にありがとうございました。
簡単だけど誰も教えてくれない、文章力を鍛える9つの基本。 : まめストリート・ジャーナル 〜無料で情報が買える唯一の新聞〜
2012年10月31日22:32 by tkfire85 簡単だけど誰も教えてくれない、文章力を鍛える9つの基本。 カテゴリ管理人 雑談 tkfire85 文章力の基本posted with ヨメレバ阿部 紘久 日本実業出版社 2009-07-24 Amazon楽天ブックス図書館文章力といえば、誰しもが悩む問題です。 お礼の文章を書く時にはもちろん、仕事でのメールのやりとりなど、現代人なら文章とは、切っても切れない関係にあります。できるなら綺麗な文章を書きたい。誰もが抱えている現代病とも言えるのかもしれません。 こうやってブログを更新していますが、できれば素敵な文章を書きたいという思いが常にあります。そんな時に出会ったのが「文章力の基本」という本です。この本では日常的な文章からビジネス文章までちょっとしたコツで格段に文章がよくなる７７のテクニックが紹介されています。全部紹介するのは無理です
「文は短く」は俗説か？ー〈短文信仰〉を屠り、短文のレトリックと長文のロジックを取り戻すために
日本語の作文教育から文章読本に至るまで、〈短文信仰〉とでも言うべきものがある。 文章表現を主題とする書籍の多くが「文は短く」と主張する。 「われわれ新聞記者は、だから、入社以来、先輩たちから、文章はできるだけ短く書くように、といわれつづけてきた。短く書こうとすると、主語と述語が近づき、事実がはっきりしてくる。込み入った因果関係のある事件などの場合には、とくにこの心構えが大切である。」（猪狩章『イカリさんの文章教室』） 「短く、短く、短く。／とにかくそれを絶えず念頭に置いてほしい。そして、短い一文に、全力を傾けていくことである。／ひとつの文に、あいまいさを残さぬことである。／文章を短くすることによって、意味のつながりを明瞭にすることができる。」（馬場博治『読ませる文章の書き方』） 「平明な文章を志す場合は、より長い文章よりも、より短い文を心がけたほうがいい。／私は、新聞の短評を書いていたころ
要約のコツを教えてくれるPDF見つけたよ: うらおもて人生感。
・要約のすすめ 読売新聞の記者代ゼミの国語科の土生さんが書いた要約のコツ。非常に読みやすい。 ※矢吹さん、訂正のご指摘ありがとうございます。 ・要約の基礎徹底 38ページもある徹底した要約講義。 軽妙な語り口でホイホイ読めちゃいます。ばっちり演習問題もある親切設計。 無料でこのクオリティは驚きの一言。 ※PDFに直リンしているので、ご注意を。 ＋0723 追記 7/22に「要約の基礎徹底」の著者、矢吹芳裕さんがツイッターで当記事をご紹介いただきました。ありがとうございます。 感謝を込めて、ここで矢吹さんの運営されているブログとwikiをご紹介します。 こちらも要約、ひいては文章書きにヒントを与えてくれる内容です。おすすめ。 僕は昨日と今日で、Garbage Out!!とwikiは読んじゃいました。すぐに読めちゃう筆致がプロい。 ・Garbage Out!! 広く文章の書き方を教え考えさせて
SEが苦手にしがちなドキュメント力を強化する5つの視点
SEに最も必要なスキルは「伝える力」だと言われています。分業が前提となるシステム開発において、意志の伝達がうまく出来ないことは致命的だからです。 よって、作成するドキュメントにも正しく伝える技術が求められるのですが、しかし多くのSEはドキュメント作成を苦手としているようです。 そこで今日は、SEがドキュメント作成で失敗しがちなポイントと、ドキュメント力を強化するための5つの視点について、『エンジニアのための文章術再入門講座』からご紹介します。 1.SEがドキュメント作成で失敗しがちなポイント SEがドキュメント作成に失敗しがちなポイントは、主に以下の2つです。 相手の関心と不一致 知識差のための説明が不足 例えば、システム開発プロジェクトの部長向けの進捗報告の場面を思い浮かべてください。性格にもよりますが、一般に部長クラスの方が気にするのは「予算を超過しないか」「顧客との関係は良好か」「今
文書品質の向上と文書作成時間の短縮：｢考えが文にまとまらない」を解決するためのテクニカルライティング
<BODY BGCOLOR="#ffffff" LINK="#ffffff" VLINK="#ffffff" ALINK="#ebc83d"> <P> <IMG SRC="fig-t8a/gb-bar-introduction.gif" ALT="テクニカルライティングの効果" ALIGN=bottom width="540" height="26"><BR> <IMG SRC="fig-t8a/tw8a-ttl.gif" ALT="文書品質の向上と文書作成時間の短縮" ALIGN=bottom width="570" height="150"><HR> <H1 style="line-height: 150%"><span style="font-weight: 400; letter-spacing: -1pt"> ｢<font color="#800000">考えが文にまとまらない<
句点の打ち方 基本編 【文章技術：句読点の打ち方】：エディテック：オルタナティブ・ブログ
これまで、以下のエントリー（文章技術：句読点の打ち方）で句読点の打ち方について検討してきましたが、読点（テン）の話ばかりで句点（マル）については説明していませんでした。そこで今回は、句点の打ち方の基本について見ていくことにしましょう。 なお、今回の「基本編」では実用文・ビジネス文書を対象とし、詩や小説などの文芸作品は扱いません。 【文章技術：句読点の打ち方】 ｜ 読点を打つ日 ｜ 読点がいっぱい ｜ 文の意味を変えてしまう読点 ｜ ご存じのとおり、句点とは 文の終わりを示す「。」の記号 のことです。このように「文の最後に打つのがマル」という説明で済めばいいのですが、実際にはあといくつか知っておかなければならないことがあります。以下では、現代的なビジネス文書では「このように書けば問題なし」という句点のルールを示したいと思います。 皆さんの会社でも、独自に「社内文書標準」のようなスタイルガイド
プレゼンやブログが伝わる文章の基本。良書に学ぶ「書く技術」 | お土産屋さんブログ
皆さんはプレゼンしたことや、ブログを書いたことありますか？ わたしの初めてのプレゼンはとてもヒドい内容で、10人の参加者全員が「？」状態でした。 その後、上司にみっちり絞られたのを今でも覚えています。 叱られてもなお「何が分からないと言うんだ！」「何で理解できないんだ！」と、相手の理解力の無さを「伝わらない」原因にしていました。 しかし、名著「考える技術・書く技術」を読み、初めて自分の伝え方に問題があったんだと知りました。 今回は、わたしを変えてくれたバーバラ・ミント著「考える技術・書く技術」を紹介してみようと思います。 １．伝わる文章の大前提 ２．ピラミッドの「良いガイド」になろう ３．どうやって読み手と対話するのか？ ４．どうやって疑問を湧き起こさせるか？ ５．どうやって「答え」を出すのか？ 伝わる文章の大前提 バーバラさんは言います。 キミは自分の思いを他人に伝えたいと思ったことはあ
「いい文章」を書くための３つのルール／まずはパソコンを閉じましょう？ - デマこい！
アカウントを取った。ブログのデザインも決めた。書きたい内容もだいたい決まっている。よし、書くぞ――。と、パソコンの前に座った瞬間に、頭のなかが真っ白になる。記事を１本書き上げるという最初のステップでつまずく人は多い。文章術をまとめたサイトもあるけれど、どうもイマイチ役に立たない。一体なにが足りないから、あなたは文章が書けないのだろう。やっぱり、才能？ ソーシャル・ブックマークのすばらしいところは、すべての文章が「生存競争」をしていることだ。まるで自然選択にかけられる生物のように「いい文章・おもしろい文章」だけが生き残る。そして「生き残った記事」とそうでない記事を比較すれば、「いい文章」の共通点が見つかるはずだ。 断言するが、文章を書くのに才能はいらない。「いい文章」の条件はたったの３つ。この３つさえ守っていれば、誰だって読みごたえのある記事を書ける。たぶん。 １．「謎」には「答え」がなけれ
【記事紹介】［保存版］読むだけで文章力が劇的に向上する良質記事まとめ８選＋α
このまとめは凄い。ものを書くことを習慣としているからには、これは目を通さないわけにはいかない記事。まとめてくれた人に感謝。 ［保存版］読むだけで文章力が劇的に向上する良質記事まとめ８選＋α【NAVERまとめ】 http://matome.naver.jp/odai/2132649894434245001
サービス終了のお知らせ - NAVER まとめ
サービス終了のお知らせ NAVERまとめは2020年9月30日をもちましてサービス終了いたしました。 約11年間、NAVERまとめをご利用・ご愛顧いただき誠にありがとうございました。
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
文章の書き方以前！文章力の基本となる意識向上のための10か条
sekailog.com
