Re:VIEWで書いた文章の校正をCircleCIとtextlintでGitHubのPRに自動コメントする仕組み - production.log
概要 技術書典でRe:VIEWを使っていたものの、文章を書き、textlintを回すというCI環境を整えることができませんでした。また、このCI環境は、ブログ執筆においても有効であるため、このタイミングで構築することにしました。 今回はRe:VIEWで書いた文章の校正をCircleCIとtextlintでGitHubのPRに自動コメントする仕組みを作ったのでその紹介をします。 概要 仕様🖋 構築手順👨💻 textlintの導入 CircleCIの設定 .circleci/config.yml textlintの実行とGitHubのPRヘコメント GitHubのアクセストークンを取得 GitHubのアクセストークンをCircleCIに設定 .circleci/review-textlint.sh 動作確認🚨 CircleCIの確認 GitHubのPRコメントの確認 まとめ✨ 仕様
エンジニアのための、いますぐ使える文章校正テクニック - ICS MEDIA
ウェブ制作や開発の仕事で文章を扱う機会は多いはず。書き手は不自然に思っていない文章でも、読み手は違和感をもっていることがあります。文章校正テクニックを覚えるだけでおかしな表現は少なくなり、読みやすい文章を書けるようになります。 本記事では、ICS MEDIAで実践している文章校正の一例を紹介します。 レベル1、基本的な校正ルールを使う いろんな場面で使える基本的な文章校正テクニックから紹介します。 テクノロジー系の名詞は正しく記載しているか テクノロジー系の名詞を間違って使うと、「本当に技術に詳しいの？」と読者からの信頼度が下がります。名詞は大文字小文字、スペース有無含めて正確に記述しましょう。 Github → GitHub（Hは大文字） Javascript → JavaScript（Sは大文字） After Effect → After Effects（複数形の「s」を忘れてはいけな
執筆・編集のためのGit（GitHub）ワークフローを考えてみた
まとまった量の文章を執筆・編集するのにバージョン管理システムを使うことは、少なくとも技術文書においては特別なことではなくなりました。 原稿が汎用のテキストファイルの場合には、バージョン管理システムとして、GitやMercurialなどのソフトウェア開発用のツールを使いたいことが多いと思います。 実際、GitHubやGitBucketを利用して技術書やドキュメントの原稿を共同執筆するという話はとてもよく聞きます（知っている世間が狭いだけかもしれないけど）。 とはいえ文章の執筆・編集という作業には、プログラムのソースコードを開発する作業とは違う側面もいっぱいあります。 そのため、ツールとしてはソフトウェア開発用のバージョン管理システムを利用する場合であっても、そのワークフローについては、執筆・編集ならではの工夫が多少は必要なのかなと考えています。 もちろん、同じソフトウェア開発でもプロジェクト
編集者が見る「わかりやすい文」を書く方法。たった一つのことをやるだけで劇的に変わるらしい「わかりすぎて心が痛い」
澤山モッツァレラ @diceK_sawayama ■編集者が見る「わかりやすい文」を書く方法 ・骨格となる論旨を箇条書きする ・それをガイドに書き始める ・一旦、思うがままに筆を走らせる ・一通り終えたら以下の通り推敲する ・形容詞を削る ・形容詞を削る ・形容詞を削る ・形容詞を削る ・形容詞を削る 劇的にわかりやすくなります。ぜひ 2018-09-05 00:21:48
校正のバイトをしててよく直す箇所10選｜bxjp
時々、校正・校閲の仕事をバイトでやっています。主に、文字・文法の間違いを正すのが校正、文章内容の事実関係の間違いを正すのが校閲、です。 校正の仕事の中心は、誤字脱字衍字や助詞（「てにをは」など）の修正ですが、「それ以外も気になったところは赤字を入れてください」と言われる場合があります。そうして見ていくと、たびたび手を入れる箇所、定番の直しというのが浮かんできました。 ここでは文章を書く人に向けて、「別に直さなくてもいいかもしれないけど、気をつけた方が読みやすい文章になるんじゃない？」というのを10コ選びました。ワタシは校正を「文章の間違いを無くす」だけでなく「文章を読んだときの違和感を無くす」ものだと考えています。なので、他の人だったら直さないかもしれないものもあります。あくまで目安として読んでください。先に項目だけ抜き出します。 1. 順接の「が」が頻出する 2. 「も」を使いがち 3.
技術書のジレンマとPEAKS + 書評ブログを書くTips #iOS11book
「iOS 11 Programming」刊行記念 Night でのLTの資料です。 https://peaks.connpass.com/event/74553/
見出し画像をつけよう （noteのはじめかた）｜深津 貴之 (fladdict)
noteに見出し記事をしっかりつけることで、あなたの記事は格段に読まれやすくなります。 これからnoteをはじめる人の入門ガイド。 読みやすく、また読まれやすいnoteの書き方を紹介します。 このガイドはあくまで、初心者のための基本的なガイドです。慣れてきたら、アレンジしたり作法を崩すなど、自身に最適なスタイルを模索をしてみてください。 ・見出し画像をつけると、読まれやすくなる ・内容にあった画像を使おう ・ソーシャルを意識するのなら、画像のサイズ比は2:1で ・大きなシルエットや構図、色面を意識しよう ・著作権にご用心 ・シリーズ物や連載モノは、統一感を出そう 見出し画像をつけると、読まれやすくなるnoteの投稿データを見る限り、「見出し画像があるnoteは読まれやすい」という統計があります。見出し画像の有無で、閲覧やライク数に数十パーセントの差がつくようです。特別な事情がない限り、すべ
どのように40万文字を超える技術書籍を執筆したのか？ - Qiita
このエントリは、ex-mixi Advent Calendar 2017の16日向けに書いたものです。 ex-mixi Advent Calendar 2017は、ミクシィを卒業したメンバーが次々と近況などを書いているカレンダーです。僕はミクシィに2009年に入社して2013年まで在籍していました。もう少しで4年間ってところの手前で離れた感じです。その後、LINEに移って、mixi Platformの経験を活かして、LINE Platformの構築を3年ほどやってました。未だに「あ、OpenSocialの人だ」って指をさされることも多いですが、そんな感じです。 前の日、つまり15日分の投稿は、エンジニアを辞めて1年が経ちました ~ ex-mixi Advent Calendar 15日目でしたが、僕のIDが3回も登場していて、朝読んだんですけど笑ってしまいました。ソフトウェアエンジニアとし
エンジニア向けライティング講座。見落としやすい注意ポイントを徹底解説！ - エンジニアHub｜若手Webエンジニアのキャリアを考える！
エンジニア向けライティング講座。見落としやすい注意ポイントを徹底解説！ 個人が趣味で運営するサイトと、企業が事業として提供するサービスでは、責任の大きさが違います。守るべき法律やライセンスがあり、モラルが厳しく問われるだけでなく、掲載する情報の正確さ、分かりやすさに気を配ることも大切です。開発を業務とするときに、エンジニアリング以外でどんなことに気をつけるべきでしょうか。 こんにちは、Webエンジニアとして企業に勤めている池田（@ikenyal）です。 この記事では、サービス開発を業務とするエンジニアが、作成したプロダクトや提供する企業の価値を低下させないために、エンジニアリング以外の部分で心がけたいポイントについて紹介します。 個人が趣味で公開しているWebサイトと、企業などが事業として提供するWebサイトでは何が違うのでしょうか？ 一番の違いは、責任の大きさだと思います。個人のサイトに
Google開発者向け文書スタイルガイドの要点 : IT翻訳者Blog
Googleが開発者向け文書で使っていた英語スタイルガイドが社外に公開された（Googleブログ）。 URLはこちら： Google Developer Documentation Style Guide https://developers.google.com/style/ MicrosoftやIBMは自社の英語スタイルガイドを書籍（リンク：MS／IBM）として販売するしているし、Appleは公開（リンク）している。Googleもマテリアル・デザインの一部としてスタイルを公開してはいる（リンク）が、分量が少ないため、他社と比べるとどうしても見劣りした。 そのため、「開発者向け文書」を対象としてはいるものの、ある程度の規模のスタイルガイドが公開されたのは意義深い。 そこで今回は、同スタイルガイドの要点（highlight）のみについて読んでみたい。 Highlights https://
わかりやすく、人に伝わる文章を書くための本おすすめ3選【文章力を上げる】 - 早稲田卒ニートブログ
ブログでわかりやすい文章が書きたいブロガー ビジネスメールや企画書で相手に意図が伝わる文章を書きたいビジネスパーソン 論文や就職活動のエントリーシートで文章の書き方に困っている大学生 など これらの人達におすすめの本を3冊紹介します。どの本も文章を書く上での基本的な考え方が書いてあり、どれか1冊でも理解し実践ができれば、人に伝わるわかりやすい文章を書くための文章力がグンと上がると思います。 1点だけ注意していただきたいのは、小説などの味わい深い表現豊かな文章を書くための本ではありません。あくまで、人にわかりやすく伝わる文章を書くための本です。 文章力を上げるには とにかく書けば文章が上手くなるって本当なの？ 文章を上手く書きたいならとにかく書けってよく聞きますよね？あれどう思います？私は本当だと思いますが、効率が悪いと思っています。 ブロガーならとにかく記事を書きまくり、ビジネスパーソンな
「自分の書く文章は価値がない」を抜け出すライティング・マラソンという方法←自己検閲を振り切って書きなぐるために
ものを書く人は自由人である（少なくともそうありたいと思っている）から、 これは書くことがとことん苦手な人のために書いた文章です→小学生から大人まで使える素敵な方法 読書猿Classic: between / beyond readers のような型（かた）の話をすると結構反発を食らう。 すでに書いている人たち向けに書かれたものでは、たとえば 書きなぐれ、そのあとレヴィ＝ストロースのように推敲しよう／書き物をしていて煮詰まっている人へ 読書猿Classic: between / beyond readers のような記事がある。 しかしレヴィ・ストロースのようにはできないという声も寄せられる。 何より、立ち止まらず振り返らず、ただ書きなぐっていくのが難しい。 心の隅から湧き上がる自己検閲の声はしばしば、書きなぐる速度よりも速く、我々をつかまえてしまう。 「本当にそうなのか？」 「そう言い切れ
今日から使える文章校正テクニック | DevelopersIO
渡辺です。 昨日のエントリーが結構反響大きめだったので、第二弾です。 文章校正をしていてよくあるパターンを幾つか抽出してみました。 ただし、前回紹介しているパターンは除外していますので、あわせて確認ください。 重複を減らす 文章校正の基礎は 重複を減らす ことです。 次の文章を見てみましょう。 AWSを使い慣れている人にとっては簡単な作業ですが、使い慣れていないと戸惑う所も多いところです。 この文章がくどく感じる理由は、「使い慣れている」が重複していることです。 前後関係もありますが「ところ」がなにを指しているのかも曖昧ですね。 後半の「使い慣れている」を削除し、バランスを取るために作業を後ろに移動しました。 さらに、前の文章を受けるため、「これは」を追加します。 これは、AWSを使い慣れている人にとっては簡単ですが、そうでないと戸惑う作業です。 スッキリしました。 しかし、「慣れていると
関西Ruby会議2017で「Rubyistと技術記事」という発表をしてきました #kanrk2017 - give IT a try
はじめに 2017年5月27日に開催された関西Ruby会議2017で「Rubyistと技術記事」という発表をしてきました。 このエントリではこの発表の内容や、イベントの様子を紹介します。 当日はこんな会場でした。広い！ スライドと発表内容の概要 発表で使ったスライドはこちらです。 スライドを見てもらえば、発表内容はだいたいつかめるはずです。 ただ、僕はスライドに書いていないことも口頭でいろいろしゃべるスタイルなので、細かい内容は会場にいないとわからないと思います。 もし「細かい内容も知りたい！」という人がいたら、Twitter等でコンタクトをください。 一般に公開していないマル秘資料（何？）をお渡しします。 8割ぐらいのみなさんが僕のことを知ってた！ 発表の途中で、会場のみなさんに「僕のことを知ってる人はどれくらいいますか？」って聞いてみたら、8割ぐらいの人が手を挙げてくれました！ こんな
禿頭帽子屋の独語妄言 side A: # 無料で使える文章チェックツール
先日、WildLightのサンプルを紹介しました。 参照リンク：side A: # こそあど、～という、～こと、～ている - WildLightの活用例 私自身がふだんからやりがちなポイントを定義ファイルに書き、WildLightで実行してマーカーを付けるという（←ほら、すぐ「～という」を使っちゃう）基本的な使い方でした。定義の内容は、（前回からすこし修正し） ・こそあど言葉のうち、「これ」系と「それ」系 ・形式名詞の「もの」と「こと」 ・文末の「～ている、strong>ていた、strong>ています」 ・文末、文節末の「～ており」 ・文節末の「～が、」 です。 このうち、「～てい」と「～ており」だけは、前に来る動詞が音便---「騒いでいる、読んでいる」のような形のこと---を起こしているときのために、ワイルドカードを使って [てで]い [てで]おり としています。 さて、WildLigh
1記事で10万PV稼ぐ『読まれる専門記事』の書き方
ブロガーの中には、プログラミング、WEBデザイン、マーケティング、経済、医療など、情報を『記事』として体系化し、多くの人に読まれている人も数多く見られます。 僕の場合、”専門知識”のレベル（≒企業研究者と対等に話せるレベル）にあるのは、生物科学、栄養学、食品衛生などでしょうか。 これらのジャンルに加え、英語の学習法などについてもいくつか書きました。 いわゆる『バズ』によって投稿直後にアクセス（数万～数十万PV）が跳ね上がった記事もありますが、全体的に『堅実な検索流入』が得られています。 専門記事はカタい印象がありますが、科学的、学術的な記事とは限らず、ハイレベルな専門知識がないと書けないわけでもありません。 今日は、僕がこれまで書いた記事を引用しながら、読まれる、読ませる専門記事の書き方について考察していきます。 専門記事とは専門記事は『誰にでも』書ける？『専門記事』というと論文レベルの専
文章が書けなくなる最大の理由とそのたった一つの解決法（あくまで個人の見解です - しいたげられたしいたけ
元は ✩←ヒトデ （id:hitode99）さんの、このエントリーに投入したブコメです。自分の誤読に気づいたので削除しました。すまそ ＞ ヒトデ さん www.hitode-festival.com 何をどう誤読したかというと、ヒトデ さんが引用した Amazon の紹介文が、こんな一文から始まっていたのです。 「書けないカギは書く前にあり」。毎月3,000本以上の記事を配信し続けるカルチャーニュースサイト「ナタリー」で実践されている文章の書き方を、一般向けに解説する初めての書籍です。 https://www.amazon.co.jp/exec/obidos/ASIN/B013DX94FC 一方、ヒトデ さんが引用した箇条書きを孫引きさせてもらうと… 自分がどんな時にラーメンを残すのかを思い浮かべてみましょう ・「多すぎる」 ・「麵ののどこしが悪い」 ・「味が濃すぎる」 ・「味が薄過ぎる」
校閲ガールにも教えてあげたい 校閲・校正 8つのツボ | 初代編集長ブログ―安田英久
今日は、オウンドメディアやメールマガジンのコンテンツ作りの際に、文章の質を高めるための「校閲・校正」のポイントをお届けします。20年の編集者人生で学んだノウハウです。 そもそも「校閲・校正」って何？ドラマ「校閲ガール」が始まりました。カドカワさんで撮影しているらしいということや、「あんなの校閲じゃない」と本職から突っ込みがあるけどドラマだからいいじゃないかとか、いろんな話がありますね。 さて、「校閲」「校正」とは何でしょうか。 校閲ガールのサイトに、こんな解説があります。 校閲【こうえつ】 文書や原稿などの、内容の誤りや不備な点を調べ、直し正すこと。 一般には、「校正」が日本語としての文章や文字を直すことで、「校閲」が事実関係や論理構成を確認して正すことのように言われることが多いですね。 要は、「正しい・適切な文章になるように」チェックして直すことです。 私は20年以上にわたって「編集」の
わかりやすさの技術 - やしお
社内向けの教育資料を、ど素人でもわかるようにと思いながら作っていて、じゃあ「わかりやすい」って何だろうって考えてた。今まで読んできたいろんなわかりやすかった本とそうでない本を思い浮かべながら、一般的にここを注意すればわかりやすさを確保できるだろうっていうポイントを一旦まとめておこうと思った。そうしてまとめてみると、本に限らず人に何かを伝えること一般に適用される話だなと思った。 読む側の負担を減らす わからない＝理解をはばむ障害物がある。この障害物を取り除く／回避する作業が「わかる」ために必要になる。その作業を、作者ではなく読者が負担するとき「わかりにくい」本になる。 日本社会だと情報の受け手の側がこの「わかる」ための作業を負うことでコミュニケーションを成立させる傾向にある。空気を読むというようなことだ。そのため発信者側が事前に手を尽くしてわかりやすく発信するというのが苦手で、相手が汲み取っ
「ダメな文章」が「伝わる文章」に激変する３つの基本！ - リクナビNEXTジャーナル
■美しい日本語やカッコいい表現はいらない 「おいおい、伝わるように文章を書いてくれよ」 「ちょっと、これ……意味が分からないんだけど？」 そんな言葉を上司や同僚から言われたことはありませんか？ 仕事で使う文章に求められるのは、「伝える」ことではなく（！）、相手に「伝わる」ことです。せっかく有益な情報をもっていても、せっかくいい仕事をしても、せっかく伝えたい想いがあっても、文章の内容が相手に伝わらなければ意味がありません。美しい日本語やカッコいい表現は必要ありません。大事なのは相手に確実に伝わることです。 残念ながら、学生のときに学んでいそうで、実は学んでいないのが、伝わる文章を書く技術です。今回は「ダメな文章」が「伝わる文章」に変わる３つのポイントをお伝えします。
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
