文書執筆の指南書で解説されている問題点を RedPen で発見する
はじめに 本稿では技術文書の指南書で解説されている文書の問題点を RedPen で発見する方法について解説します。紹介する文書の問題点は以下の指南書で解説されている内容です（執筆者の敬称略）。 理科系の作文技術（木下 是雄） 数学文章作法（結城 浩） 文章の書き方（山本 和彦） 上記の指南書で解説されている問題点の多くはシンプルです。しかし残念ながら、指南書で解説されている文書の問題点はプログラムのコーディング規約ほど広く認知されていません。さらに問題点に注意しながら文書を執筆するのは簡単ではありません。たとえば、textlint を開発されている @azu_reさん は以下のように述べています。 あなたはIMEほど記憶能力が高くないが、IMEはあなたほど賢くない。 なので二つで作った文章には綻びが生じやすい。 それをtextlintやRedPenなどの第三者が見つける。 — azu (@
textlintで日本語テキストの文字校正を試してみた - the code to rock
はじめに 導入 textlintrcを設置 最初のつまずき prh を使ってみる | 2度目のつまずき 追記: 絶対パスにも対応して頂きました prh を使ってみる（2） | 辞書を選ぶ 結果をテキストファイルに書き出す 追記: [39m[32m などを消す方法 コードを書く tx.sh textlint_pretty_error_tidy.pl Vimから使えるようにする 展望とまとめ はじめに textlintについては少し前から時々名前を聞くなと思っていましたが、自分に関わりがありそうなものとして意識したきっかけは、@t_wada さんによる以下のツイートだったと思います。 とある技術文章のレビューをする際に、細かな言い回しの修正を逐一指摘する代わりに textlint を入れてもらったら、文章がみるみる良くなってきているのをリアルタイムに見ている。 textlint は偉大だ。—
「ヤフコメ」と「はてブコメント」の違い。テキストマイニングより見えてきたもの - プリキュアの数字ブログ
（プリキュアにあんまり関係ない記事です。興味ない方はスルーして下さい。） 先日（4/13）、当ブログを紹介していただいた朝日新聞withnews様の記事が、（数時間ですが）ヤフーのトップに掲載されました。 娘がプリキュアに追いついた日… 父のブログに涙する人が続出 当たり前の日常の中にある愛情、著者に聞く （withnews） - Yahoo!ニュース さすがにヤフーのトップ、記事中に直接リンクが貼ってあったわけではありませんが、多大な反響があり、その1日だけで「イワオ～キン骨マンの超人強度」くらいにはＰＶを頂きました。 はてなブックマーク、ツイッター含め、沢山のコメントを頂きまして、本当にありがとうございました。 すべてのコメントを読まさせていただきました。 その全てが、ありがたく、身に染みるものでした。 で、今回「ヤフーのトップニュースに載る」ことにより、 「自分のブログ記事の内容が”
なぜタイポグラフィにおいてVertical Rhythm（バーティカルリズム）は重要な手法なのか？ | POSTD
Webのタイポグラフィについて少しでも調べたことがあるなら、 Vertical Rhythm という言葉を耳にしたことがあるのではないでしょうか。タイポグラフィを用いて仕事をする場合、最も重要な手法の1つです。このことについて知って以来、私は自分のサイト全てにVertical Rhythmを使っています。 ある日、Vertical Rhythmの重要性について自分が全く理解していないことに突然気付き、愕然としました。そしてその後すぐに2つの疑問が湧き上がってきました。「なぜVertical Rhythmを使うとサイトのデザインが向上するのか？ 」「自分のデザインを良くするために、Vertical Rhythmから何を学べばいいのだろうか？ 」。 私はこの疑問を解明しようと決めました。その考察を綴ります。 記事の最初にあたって認識を共通にするため、まずはコンテキストについて説明します。 Ve
RedPen でわかりやすい技術文書を書こう | DevelopersIO
最近はブログを始めマニュアルや仕様書など技術文書を書く機会が多くなってきました。 技術文書はわかりやすさが重要だと思うのですが実際は書けていません。 どうしたらわかりやすい文書が書けるのだろうか？と調べていたら RedPen というツールを見つけたので早速試してみました。 RedPen とは？ RedPen とはプログラマや記者が規約に従って文書を記述するのをサポートしてくれるオープンソースのソフトウェアツールです。 プログラミングが規約に従ってコーディングされているかチェックするように、RedPen は自然言語で記述された入力文書の検査を自動化してくれます。 RedPen の特徴 設定が柔軟に行えます。（カスタマイズも柔軟） どのような言語で書かれた文書でも処理できます。（もちろん日本語も OK です） Markdown や Textile フォーマットで記述された文書をそのまま検査でき
「お役所言葉 改善の手引」は文章作成マニュアル！ 専門用語は言い換えを | 初代編集長ブログ―安田英久
今日は、Webライティングにもメールにも役立つはずの、「わかりやすく、読みやすい」文章を作るための日本語を解説したマニュアルを紹介します。これは、すべての社会人が読むとその日からトクする情報です。 いわゆる「お役所言葉」改善の手引 by 佐賀県「いわゆる『お役所言葉』改善の手引」という、佐賀県が2004年に公開した文書があります。文書名だけ見ると「なんだ、また意味のない無駄なやつか」と思うかもしれませんが、これが非常に役に立つ内容だったのです。 佐賀県：いわゆる「お役所ことば」改善の手引きの策定 なにが役に立つって、本当に「わかりやすい、読みやすい、伝わる」文章を書くための基本をシンプルかつ明確に、具体的な例を示しながら解説してくれているのです。 内容はこんな感じです。 できるだけ具体的な表現を的確で簡潔な文章を、まずは結論から行政で多用される慣用語の見直しをカタカナ語（外来語）は普及して
文書校正ツール textlint の Chrome 拡張を作った - もなでぃっく
以前、プラグインで拡張可能な文章校正ツール textlint で小説の作法を検証するための規則を作ったのですが、textlint はコマンドラインツールであるために利用するまでのハードルが高い状況でした。 Sublime Text や Atom などのプログラマ向けエディタを利用していれば、textlint のプラグインが使えたりするのですが、今回はより簡単に利用できるように Chrome の拡張機能として textlint をブラウザ上で使えるようにしてみました。 インストールはこちら: 【Chrome ウェブストア】 textlint: 文章チェッカー インストールすると、ページ内の編集領域で文章入力中にリアルタイムで校正してくれるようになります。（もちろん ON/OFF できます） textlint に最近追加された自動修正機能にも対応しているので、ボタン一発で自動で修正されたりしま
エンジニアが手早く英作文をする時はかどる Tips - tomoima525's blog
GithubのPRや海外Slackチャンネルでチャット、はたまた英語圏のエンジニアとやりとりする等、英語で文章を書くことはしばしばあります。そんな時、自分がよく使っている方法について書きます。 先に一番大事なこと 大事なことは、英語はあくまでもツールだということです。伝えたい内容が重要であり、英文を書くことに時間かけることはエンジニアにとって不毛です。 よっぽど英語が得意な人でないかぎり、一から英作文すると時間がかかって本質的でないところで時間を消費するということです。 なので一から文章を考えるのでなく、なるべく"型"を知ることがポイントだと考えています。それを踏まえた上で御覧ください。 文章を書く アルクの英辞郎とGoogle, Githubを組み合わせる 恐らく多くの人がGoogle翻訳などを使って英文を作っているかと思うのですが、アルクの英辞郎と組み合わせるともっとはかどります。理由
法律用語のキソ
●大勢の法律家が列席したとある結構披露宴でのこと・・・。 ある人が「新郎並びに新婦は…」と祝辞をやりだしたところ、 という野次が飛び交ったとか。 これは真偽のほどは定かでない笑い話ですが、法律家はこれ位、「及び」と「並びに」を厳格に使い分けています。 ●「及び」「並びに」は、どちらも並列的接続詞として使われます。「および」「ならびに」とひらがなで書いても同じ意味です。 まず、結合される語が同じ種類だったり、同じレベルのものの場合は「及び」を使い、
催促・お詫び・お断り…送りにくいメールをスマートに送る プロの具体文例集 - リクナビNEXTジャーナル
仕事上で発生する連絡事項には、「どうも言いづらいな…」というものも多々ありますよね。 例えば、相手に負担を強いるような依頼のほか、催促、お詫び、断り…など。 相手を目の前にして直接伝えるのであれば、声のトーンや表情によって感情を伝えられるので、何とかうまいことやれるような内容も、メールだと中々…。こちらは全くそんな気はないのに、妙にカドが立って相手を不快にさせてしまったり。 一体どうすればこうした「伝えづらい内容」をメールでいい感じに送れるのか？ 日本ビジネスメール協会の代表理事であり、ビジネスメールやコミュニケーションに関するコンサルティング・教育を手がける(株)アイ・コミュニケーションの代表を務める平野友朗さんにお聞きしました。 ▲(株)アイ・コミュニケーション代表の平野友朗さん 【前提】一つの言葉でも、自分と相手のとらえ方は異なることを意識する 前提として意識しておきたいのは、自分で
ルールプリセットを使ってお手軽にtextlint入門
textlintはルールで拡張出来る自然言語向けのLintツールです。 textlint 5.1.0でルールのプリセットをサポートしました。 ルール、プリセット、プラグインは以下のような関係です。 rule いわゆるルール rule-preset ルールをまとめたもの plugin ルールとプロセッサ(拡張機能)を持ってる textlintはデフォルトでは一つもルールを持っていません。 そのため、どのルールを入れたらいいか迷った場合に、誰かがまとめてくれたプリセットをとりあえず入れれば、とりあえず文章のチェックが出来るようになります。 textlintの使い方は以下で解説しているのと基本的に同じですが、今回はプリセットの使い方を紹介します。 textlintで日本語の文章をチェックする | Web Scratch インストール textlint本体と2つのプリセットをインストールしてみます
Gitのコミットメッセージの書き方 | POSTD
(訳注：2015/10/31、いただいた翻訳フィードバックを元に記事を修正いたしました。) (訳注：2015/11/1、いただいた翻訳フィードバックを元に記事を再修正いたしました。) 訳： プロジェクトが長引くほど、私のGitのコミットメッセージは情報が薄くなっていく。 イントロダクション | 7つのルール | ヒント イントロダクション：なぜ良いコミットメッセージを書くことが重要か Gitのリボジトリのログをランダムに閲覧すると、ひどいコミットメッセージを目にすることがあります。例として、私が昔書いたSpringにコミットした これらのgem を見てみましょう。 $ git log --oneline -5 --author cbeams --before "Fri Mar 26 2009" e5f4b49 Re-adding ConfigurationPostProcessorTest
日本語文章のスタイルガイドのまとめ - Qiita
JTF日本語標準スタイルガイド（翻訳用） 実務翻訳において和訳時に使用できる日本語表記ガイドラインです。 このルールを適応出来るtextlintプラグインを書いた azu/textlint-plugin-JTF-style JTF日本語標準スタイルガイドのルールセットで文章をチェックできるtextlintプラグイン | Web Scratch 外来語（カタカナ）表記ガイドライン第3版 カタカナの長音や複合語の際の表記についてのガイドライン JIS Z 8301:2011 規格票の様式及び作成方法ではちゃんと決められてない部分についても書かれている Download International Style Guides - Microsoft | Language Portal Microsoftの各言語別の翻訳スタイルガイド(日本語向けもある) 『社会学評論スタイルガイド』 日本の社会学分
文章が苦手でも、ビジネスシーンで「わかりやすいドキュメント」を作成する方法 - リクナビNEXTジャーナル
Photo by Sebastien Wiertz みなさんの提案書や報告書、メールなどのドキュメントはわかりやすいでしょうか。ビジネスではさまざまなシーンでドキュメントが使用されますが、日本人にとって日本語で文章を書くことはあまりに自然すぎて、クオリティや効果といった要素はあまり意識されていないように思います。 ここでドキュメントを作成するそもそもの目的に立ち返ってみましょう。数千万円の予算が動くプロジェクトの提案書であれ、社内で発生したトラブルの経緯報告書であれ、進行している案件についてのクライアントとのメールであれ、すべてのドキュメントには共通した目的があります。 それは「文章によって人を動かす」ことです。予算の承認も、トラブルの解決も、スムーズな案件の進行も、それを媒介しているのは文章のクオリティであり、効果です。したがって、ビジネスにおいて使用されるドキュメントは、徹底してわかり
textlint + prhで表記ゆれを検出する
proofread-helper proofread-helperは@vvakameさんが作っている文章の校正補助ツールです。(TechBoosterとかの執筆で使っている?らしいです) 機能としては表記ゆれの辞書を指定して、そのルールに則って文章のチェック、また期待する単語への書き換えを行うことができます。 ものすごくざっくり書くと、期待する単語と表記ゆれを補足する正規表現の組み合わせを持った辞書を作ってチェックするような形です。 仕組み的にはazu/technical-word-rulesと殆ど同じですが、辞書をyaml形式で書けたり、辞書内に期待通りに動いているのかの簡単なテストも書くことができます。 なので、辞書の追加や管理がしやすいと思います。 例えば、以下のように辞書を書くことができます。 version: 1 rules: # expectedのみだと 大文字小文字全角半角の
RedPen
RedPen is a proofreading tool to help writers or programmers who write technical documents or manuals that need to adhere to a writing standard. RedPen automates the verifications of input documents written in natural languages — NOT computer languages such as C++ or Java. RedPen はプログラマや記者が規約にしたがって文書（マニュアルやソフトウェアドキュメント）を記述しているか検査します。 RedPen は自然言語で記述された入力文書のチェックを自動化します。 Customizable 柔軟な設定 RedPen is
DMM inside
なぜDMMがweb3に参入したのか。Seamoon Protocolが目指す新たなエンタメ体験の未来とは
そのキャッチコピー本当に「刺さる？」を判断する、ある１つの質問
そのサイトで相手に届けたいメッセージを凝縮した物が「キャッチコピー」ですよね。 ランディングページにしても、ホームページのトップページのメインビジュアルにしても、キャッチの良し悪しは、マーケティングの成功に直結します。 もし失敗すると、例えばこんなことが起きます CVR（コンバージョンレート）が思うように上がらない 想定していたターゲットと違う申込者や問合わせが増える バックエンドが苦労する そんな大事な「キャッチコピー」の考え方ですが、経験上ユーザに響きやすくなる順に大きく３つのステップがあると考えています。 今回はそのステップをいかに上がっていくかという内容です。 「キャッチコピーについて、作り方で悩んでいる」「何回やっても変えても、あまり改善しない」「上手くいっているコピーと、そうで無いコピーの差を知りたい」といった方向けです。 キャッチコピー「考え方」の３段階 大前提 キャッチコピ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
http://user.keio.ac.jp/~matsuoka/englishemail.htm
インフラエンジニアの綺麗で優しい手順書の書き方
