読みたくなるREADMEを書くためのコツ - Qiita
はじめに こんにちは！ご訪問いただき、ありがとうございます！ 僕は現在、エンジニアとしての就職を目指しながら、インボイス制度に対応した請求書を、Web上で作成・発行できるサービスの開発をしています。 その開発を進めていく中で、読んでもらえるREADMEを作成したいという想いから、世の中の開発者がどのようにREADMEを作成しているのかを、GitHubで調べて分析をしました。 本記事では、たくさんのREADMEを見て学んだ、読みたくなるREADMEを書くためのコツを、実際に僕が作成したREADMEを例にしてご紹介します。 実際に作成したREADME 前提 今回ご紹介する内容は、未経験でエンジニア就活をする際に、採用担当の方が読みたくなるようなREADMEを作成することを目的とした内容となります。 また、実際に作成したREADMEを例にコツのご紹介していますが、時間の兼ね合いで、学んだコツを反
Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい - Qiita
はじめに エンジニアにとって、仕様書などの技術的な文章を書くこと（テクニカルライティングとも言います）は避けて通れません。ただ20年来多くのエンジニアの方々と同僚として接してきて思うことは、エンジニアの方の中には「文章を書く」ということに苦手意識がある方が一定数いるということです。 でもこの「テクニカルライティング」のスキルは、才能というよりは一種の「技能」だと思うんです。ある一定の原理原則を理解して実践を繰り返すことで、必ず一定レベルで習得できるものだと著者は信じています。 もしこのテクニカルライティングの原理原則をまだ体系的に学習したことがない、または過去学習したが改めて再学習したいという方に、お勧めのコンテンツを見つけたのでご紹介します。 https://developers.google.com/tech-writing Every engineer is also a write
「作文が書けない子」に本当に必要な訓練の話
先日、東洋経済さんでこんな記事を拝読しました。 ｢作文｣が書けない子に教えたい3つの言葉 文章を書くことは、観察し、驚きを見つけ、考えることです。これがステップ1からステップ3への手順に当てはまるのです。 （東洋経済オンライン） 正直なところ、この記事を書いた方は「作文が書けない子」のレベルをかなり高く見積もっているなあ、と感じました。 いや、文中のテクニック、文中の手法が悪い、というわけではないのです。ここに書かれていることは、それはそれで非常に有用、非常に有効なことだと思います。 「観察→深堀りと整理→考察」という思考法は、あらゆる表現、あらゆる論考で重要な手順です。 小さい頃からこの手順になじんでおくことはとても有益ですし、その際の教え方、かみ砕き方として、文中提示されているような言い方をするのも有効でしょう。そこについては何の文句もないんです。 ただ、ここでいう「作文が書けない子」
技術書を作るための技術スタック | メルカリエンジニアリング
Mercari Advent Calendar 2017の3日目はmhidakaがお送りします。 Advent Calendarで空いてるところに収まったら12月3日は日曜日ということで、エンジニアの趣味的な話です。 筆者は技術的なブログや書籍を書くかたわら、技術書のためのイベントなどを開いてます。 技術を追求すること、プログラミング、まとめることが好きでモバイル分野で継続的に書籍を出版しています。 内容はおおむね同人誌作りへ適用している技術の話です。 書籍の作り方は出版社によっても違いますが、紹介する内容と同様の作り方をしている商業書籍もたくさんあります。 ここでは著者の目線から出版業界のテクノロジーをのぞいてみましょう。 作る楽しみと読者の視点 著者が本を書く動機は人それぞれですが技術を広めたい、たくさん売れたい、自分の知識をまとめたいなど目的を持って書き始めます。 また一方で書籍の目
文章が苦手でも、ビジネスシーンで「わかりやすいドキュメント」を作成する方法 - リクナビNEXTジャーナル
Photo by Sebastien Wiertz みなさんの提案書や報告書、メールなどのドキュメントはわかりやすいでしょうか。ビジネスではさまざまなシーンでドキュメントが使用されますが、日本人にとって日本語で文章を書くことはあまりに自然すぎて、クオリティや効果といった要素はあまり意識されていないように思います。 ここでドキュメントを作成するそもそもの目的に立ち返ってみましょう。数千万円の予算が動くプロジェクトの提案書であれ、社内で発生したトラブルの経緯報告書であれ、進行している案件についてのクライアントとのメールであれ、すべてのドキュメントには共通した目的があります。 それは「文章によって人を動かす」ことです。予算の承認も、トラブルの解決も、スムーズな案件の進行も、それを媒介しているのは文章のクオリティであり、効果です。したがって、ビジネスにおいて使用されるドキュメントは、徹底してわかり
ライティングのプロに学ぶ！文章力UPに役立つ良記事&良書30選
「ライティングスキルを向上させたい」と思っているはいるものの、何をすればいいか分からないという人、多いのではないでしょうか？「文章力」は一朝一夕で身につくものではありませんが、プロの技術や考えから、すぐに使えるノウハウやエッセンスは学び取ることができます。 そこで今回は、「ライティングスキルを磨きたい！」と思っているWeb編集者に向けて、確実に読んでおくべきライティングのノウハウが学べる記事と本を30個まとめました。 これだけは読んでおきたいライティング系の記事 1.ライティングでは書き始める前の考えの整理や視点の確認が大切editor’snaut(※2020年8月現在ブログ閉鎖中) THE BRIDGEやマチノコトといった複数の媒体でエディター/ライターとして活動するモリジュンヤ氏が、文章を書き始める前に頭の中を整理することの重要性を説いた記事。思考の整理に役立つオススメの書籍も紹介され
誰にでも物語を作れる方法をアドバイスする番組がもの凄く良かったのでメモ!! - 強火で進め
ポッドキャストで聞いていてとても良い内容の番組だったのでメモ!! スクリプトドクターとして活躍されいる三宅隆太さんから女性アナウンサー山内あゆさんが物語の作り方を教わるという番組でした 。 番組シーン (山内) 三宅隆太さんは脚本家、映画監督であり、日本に数人しか居ないと言われている脚本のお医者さんスクリプトドクターとしても活躍してらっしゃるんですよね (三宅) 事前にお話作りの為の書き込みシートを渡して記入して頂いている ■書き込みシートの内容 Q1 : あなたのお話の主人公はどんな人ですか？ A1 : 小学生くらいの男の子。変身が出来る。性格は優柔不断 (掘り下げの質問) Q1 : その主人公は好きなことや好きなものは有りますか？ A1 : 虫とか動物が好き (掘り下げの質問) Q1 : 逆に嫌いな事や嫌いなものは？ A1 : 暗闇や恐いこと Q2 : あなたのお話は主人公が何をしよう
ブロガー必読！誰でも分かりやすく、読みやすい文章が書けるようになる5ステップ 〜本『文章は読むだけで上手くなる』 - ライフハックブログKo's Style
あなたはブログを書くとき、まず何をしますか？ 本『文章は読むだけで上手くなる』は、『日経ビジネスアソシエ』創刊編集長、作家の渋谷和宏氏が、30年にわたるキャリアの中で構築したノウハウを全公開したもの。 SNSやネットが普及したこの時代。「文章力」がその人の影響力を左右します。 小説のような美しい文章ではなく、ブログやメールのような「伝わる文章」を書くなら、「型」を知っておけば、もっとスラスラと進められるのです。 今日は本書から、誰でも分かりやすく、読みやすい文章が書けるようになる5ステップを紹介します。 1. 最も伝えたい内容あるいはメッセージを言葉にする「最も伝えたい内容あるいはメッセージ」を確定しましょう。 そのためにどうするかと言うと、文章全体を通して何を最も伝えたいのか、あるいは伝えられそうなのか、思いつくまま言葉にしてみるのです。気の利いた言い回しである必要はありません。的確な言
Web編集者・ライターが間違うと恥ずかしい日本語の正しい用法10選 | 株式会社LIG(リグ)｜DX支援・システム開発・Web制作
こんにちは、LIGブログ編集長の朽木（@amanojerk）です。いま僕の背後では、社長から「デスクが汚い」と怒られたらしい上司が「守破離しなきゃ、守破離…」とブツブツ言いながらゴミを捨てています。 ちなみに、守破離（しゅはり）とは、 まず師匠に言われた型を「守る」ところから修行がはじまり、その型を研究してより自分に合った型をつくることで既存の型を「破り」、最終的には師匠の型、そして自分自身の型からも「離れ」て自在になる。 という意味の、要するに剣道とかのヤツです。多分なんですけど、断捨離（だんしゃり）って言いたかったんだと思います。 さて、かく言う僕も編集・ライティング業務に従事しておりますが、出版社や編集プロダクションの勤務歴はありません。また、今でこそ社内の編集者たちをとりまとめる立場ですが、僕の入社以前は社内に商業経験のある編集者・ライターがほとんどおりませんでした。 何が言いたい
Web制作者が助かるヒアリングシートや問い合わせ返信に使えるテンプレート - コムテブログ
TL;DR 遠方のお客様からのサイト制作依頼、メール問い合わせがあった時に、どんな内容を返信すればよくて、どんなことを聞いておけば概算見積もり（初期費用・ランニング費用）を作りやすくなるのか。ヒアリング時も、ある程度聞き出したい。 ネットや本でも意外と「具体的な例」がないなぁと思い、今回はコーポレートサイトや EC サイト制作依頼があった時に、メール返信や、最低限クライアントに聞いておきたいことや尋ね方をまとめました。ヒアリングシートにも応用できます。会社によって違うと思いますが、ざっくりとメモしておきますので、後は自分流にアレンジしながらご活用ください。 メール用テンプレート ここからはメール返信用です。 コーポレートサイト コーポレートサイトの制作依頼があった時に、具体的にどんな内容をヒアリング、または聞いておけばよいのか項目をまとめました。聞き出した内容をもとに社内スタッフと共有し概
第7回 今日から実践できる！ 非ライターのためのライティング入門 - MdN Design Interactive
知ってるつもりで意外と知らないSEO最新のキホン 第7回 今日から実践できる！ 非ライターのためのライティング入門 2014年12月9日 TEXT：寺田祐也（ヴォラーレ株式会社） こんにちは。ヴォラーレ株式会社の寺田です。今回は、先日前後編でお届けした「SEOに効く、良いコンテンツのつくり方」で立てた企画を生かす方法として、どうライティングするのか（書くのか）について考えていきたいと思います。 Web系の制作・運用業務に携わる人は、非ライターであってもテキストを書く機会は多くあると思います。たとえばライターが納品したテキストにリード（導入）文やdescriptionを追加する、などなど。特にオウンドメディアなど自社コンテンツを拡充していこうという流れの中、「○○について、とりあえず書いといて！」と言われる機会が少なからずあるのではないでしょうか。 専門的な記事となると、ブログであっても30
FINDJOB!終了のお知らせ | FINDJOB!
FINDJOB! 終了のお知らせ 2023年9月29日にFINDJOB!を終了いたしました。 これまでFINDJOB!をご利用いただいた企業様、求職者様、様々なご関係者様。 大変長らくFINDJOB!をご愛顧いただき、誠にありがとうございました。 IT/Web系の仕事や求人がまだ広く普及していない頃にFind Job!をリリースしてから 約26年間、多くの方々に支えていただき、運営を続けてまいりました。 転職成功のお声、採用成功のお声など、嬉しい言葉もたくさんいただきました。 またFINDJOB!経由で入社された方が人事担当になり、 FINDJOB!を通じて、新たな人材に出会うことができたなど、 たくさんのご縁をつくることができたのではないかと思っております。 2023年9月29日をもって、FINDJOB!はその歴史の幕を下ろすこととなりましたが、 今後も、IT/Web業界やクリエイティブ
物語は作れたがどんな文章で小説にしていいか分からない人のための覚書
前回の記事 生まれてはじめて書く人のための、小学生向け小説執筆マニュアル（手順書） 読書猿Classic: between / beyond readers について、物語の作り方はわかった気がするけど、それをいざ小説にしようとすると言葉が出てこない、なんとかしろ、という意見がありました。 実は、小説の文章についても少し書いていたのですが、あまりにも小学生向けでなかったので省きました。参考になる人がいるかもしれないので出してみます。 １ 小説の文章は何からできているか？ 小説は、文章を通して物語を伝えるものです。 小説の文章は、大きく３つに分けられます。 《場面》、《説明》、《描写》です。 （１）説明とは 《説明》は、物語を大づかみに述べる文章です。細かいところを省略して伝えるので《要約》と呼ばれることもあります。 大づかみなので、少しの文章で、長い時間の物語を伝えることができます。 わず
心理学者が教える少しの努力で大作を書く／多作になるためのウサギに勝つカメの方法
Author:くるぶし（読書猿） twitter:@kurubushi_rm カテゴリ別記事一覧 新しい本が出ました。 読書猿『独学大全』ダイヤモンド社 2020/9/29書籍版刊行、電子書籍10/21配信。 ISBN-13 : 978-4478108536 2021/06/02 11刷決定 累計200,000部（紙＋電子） 2022/10/26 １４刷決定 累計260,000部（紙＋電子） 紀伊國屋じんぶん大賞2021 第３位 アンダー29.5人文書大賞2021 新刊部門 第１位 第２の著作です。 2017/11/20刊行、４刷まで来ました。 読書猿 (著) 『問題解決大全』 ISBN:978-4894517806 2017/12/18 電書出ました。 Kindle版・楽天Kobo版・iBooks版 韓国語版 『문제해결 대전』、繁体字版『線性VS環狀思考』も出ています。 こちらは１０刷
文章のプロ直伝！素人でもプロ並に書けるようになる５つのテクニック
ユーザーに届ける価値を徹底的に追求する マーケティングを提供します © Copyright 2022 バズ部. All rights reserved. 文章力は、ビジネスの世界で、今まで以上に非常に重要なスキルとなっている。 例えば、広告やダイレクトメールなど、消費者に向けてのメッセージは文章力に大きく依存する。 また、興味のある人に対してコンタクトを取って、アプローチする際も、あなたの書くメールや手紙などの文章の内容によって、成否は大きく左右される。 思い返せば、私は、社会に出る前の学生の頃から、大学で、大量の本を読み、週に２〜３本のエッセイを書いたり、レポートを提出したりしていた。 そして、こうやって培って来た文章力によって、ビジネスにおける様々な面で得をしていることを実感している。そこで本日は、私が実際に使っている文章テクニックを５つご紹介する。 この通りに書いて頂くだけで、プロの
サービス終了のお知らせ - NAVER まとめ
サービス終了のお知らせ NAVERまとめは2020年9月30日をもちましてサービス終了いたしました。 約11年間、NAVERまとめをご利用・ご愛顧いただき誠にありがとうございました。
サービス終了のお知らせ - NAVER まとめ
サービス終了のお知らせ NAVERまとめは2020年9月30日をもちましてサービス終了いたしました。 約11年間、NAVERまとめをご利用・ご愛顧いただき誠にありがとうございました。
７．売れないライターだった私の成約率を５倍にしてくれたクロージング手法
ユーザーに届ける価値を徹底的に追求する マーケティングを提供します © Copyright 2022 バズ部. All rights reserved. 一時期、私は、何を書いてもセールスレターの成約率が上がらず、自分のコピーライティングのスキルに自信を失いかけていた。 読み手の反応も良い。セールスレターを呼んだ人から、多数の問い合わせや個人的な相談メールも貰える。 しかし、そうした反応はあるのに、実際にお金を出して商品を購入してくれる人がほとんどいないのだ。結果、「自分のコピーライティングには何が足りないのだろうか？」と何ヶ月も悩み、様々な人に相談し、様々なことを試した。 今となっては笑い話だが、「最後の最後で購入してくれないのは、お前が女にモテないからだ。」と言われ、苦手なナンパの練習をしたりしたほどだ。 ここで、お伝えするクロージングテクニックは、そうした経験を乗り越え、それまでの５
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Design Doc の書き方 / How to Write a Design Doc (Ja ver.)
インフラエンジニアの綺麗で優しい手順書の書き方
