はてなブックマーク

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? はじめに 本稿では技術文書の指南書で解説されている文書の問題点を RedPen で発見する方法について解説します。紹介する文書の問題点は以下の指南書で解説されている内容です（執筆者の敬称略）。 理科系の作文技術（木下 是雄） 数学文章作法（結城 浩） 文章の書き方（山本 和彦） 上記の指南書で解説されている問題点の多くはシンプルです。しかし残念ながら、指南書で解説されている文書の問題点はプログラムのコーディング規約ほど広く認知されていません。さらに問題点に注意しながら文書を執筆するのは簡単ではありません。たとえば、textlint を開

「することができる」とは 技術文書を読んでいると「することができる」「することが可能である」という表現を目にします。実はこの「することができる」という表現は冗長なため有害、つまり多用すべきでないという考えがあります。 気になって「することができる」についてGoogleで検索してみました。結果、「することができる」という表現について書いたブログ記事をいくつか見つけました。以下、発見したブログ記事の一覧です。 読みやすい文章の極意は「修飾語」にあり 読みやすい文章を書くために心がけたい１０のポイント 感性工学的テキスト商品学～書き言葉のマーケティング 列挙したブログ記事の全てで「することができる」を多用しないように警告しています。 「することができる」を自動で検知 私も「することができる」「することが可能である」のような冗長表現をできるだけ利用しないように気をつけています。「することはできる」

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? 文（センテンス）の長さについて関心が払われていない技術文書は読むのに時間がかかります。特に日本語の長い文の内容が掴みにくく感じるのは、英語の節のように文内のブロックが明示的に分かれていないせいなのでしょうか。このあたりは私は専門でないので、正直よくわからないです。 残念ながら技術文書を書いた経験が十分でない執筆者（初学者）が書く文は高い確率（ほぼ百パーセント）で文が長いです。かくいう私が十数年前に書いた文も、今と比べて五割以上長かったことを覚えています。本稿では、なぜ文が長くなってしまい、どう解決するのかについて解説します。 なぜ文は長

RedPen はマークアップ言語（Markdown、AsciiDoc、LaTeXなど）で書かれた技術文書を検査するツールです。 RedPen が提供する特徴のひとつに複数の自然言語への対応があります。つまりユーザは RedPen をつかって日本語で記述された文書だけでなく、英語文書の検査もできます。今回は RedPen をつかって英語文書を検査する際の、おすすめ設定について解説します。 英語文書用の設定でも日本語の場合とおなじように、必要な機能を追加してゆくだけです。英語文書の検査で使用する機能の一部は日本語の検査で利用したものです。そのため英語文書用の設定は日本語のものと類似した設定となります。 はじめの設定(やっぱり文長まわり) 対象となる文書が英語の場合でも、まずおすすめしたいのは文長関係の機能だけを追加する設定です。基本的に文が長いと読みにくいのは対象言語に依存しません（英語の方が

上の設定では二つの機能が登録されています。 SentenceLength 文の長さ自体を検査する機能。上記の設定では文の最大長を100文字に設定している。 CommaNumber 文中のコンマの数を検査。デフォルトでは最大四つ。 上の設定はどれも文の長さに関連する検査です。たとえばコンマの数や同一単語の複数回の利用は文が長ければ検査に引っかかる可能性が増えます（注: DoubledWord は削除しました 2016/05/11）。先に述べたように一度文を短く揃えてからが、本格的な文書の校正の開始です。文が短く揃っているために文書が頭に入ってくるスピードが増して校正作業がスムーズにすすみます。 表現に関する設定 次に文書内の表現に関する機能を加えてみます。 <redpen-conf lang="ja"> <validators> <validator name="SentenceLength