文書執筆の指南書で解説されている問題点を RedPen で発見する
はじめに 本稿では技術文書の指南書で解説されている文書の問題点を RedPen で発見する方法について解説します。紹介する文書の問題点は以下の指南書で解説されている内容です（執筆者の敬称略）。 理科系の作文技術（木下 是雄） 数学文章作法（結城 浩） 文章の書き方（山本 和彦） 上記の指南書で解説されている問題点の多くはシンプルです。しかし残念ながら、指南書で解説されている文書の問題点はプログラムのコーディング規約ほど広く認知されていません。さらに問題点に注意しながら文書を執筆するのは簡単ではありません。たとえば、textlint を開発されている @azu_reさん は以下のように述べています。 あなたはIMEほど記憶能力が高くないが、IMEはあなたほど賢くない。 なので二つで作った文章には綻びが生じやすい。 それをtextlintやRedPenなどの第三者が見つける。 — azu (@
RedPen のおすすめ設定 - Qiita
注意 本文書は RedPen v1.8 の利用を想定して書かれています。 はじめに RedPen をインストールして同梱されている設定ファイルで文書を検査すると、相当な量のエラーが出現してしまい少々ゲンナリしてしまいます。大量のエラーが出現してしまうのは、個人や執筆グループによって異なることが多い検査も、デフォルトの設定ファイルに追加されているためです。 今まで RedPen の利用方法や設定方法について記事を書いたのですが、具体的な設定をどうするのかについてあまり触れてませんでした。本記事は RedPen のおすすめ設定に関するまとめとなっています。また、RedPen が提供する各機能が作られた意図について書かれた記事「文書執筆の指南書で解説されている問題点を RedPen で発見する」があります。本稿を読む前に一読しておくとよいでしょう。 はじめの設定（文長まわり） はじめて RedP
RedPenのValidatorをJavaScript で書くには - 2015-08-29 - ククログ
はじめに RedPen という技術文書の校正に使うことを目的としたソフトウェアがあります。 RedPen - A document checker コマンドラインから RedPen を起動して文章をチェックしたり、RedPen サーバを稼動させ、REST API 経由で使うこともできます。 RedPen そのものの詳しい説明は、開発者による連載記事があるのでそちらを参照するとよいでしょう。 RedPenを使って技術文書を手軽に校正しよう 今回は、RedPen 1.3 からサポートされた、JavaScript による Validator を書く方法を紹介します。 RedPen のセットアップ RedPen の リリースページ からこの記事を書いている時点の最新版である RedPen 1.3 をダウンロードします。 redpen-1.3.0.tar.gz ダウンロードできたら任意のディレクトリ
Atom Flight Manual
CompanyEngineeringProductSunsetting AtomWe are archiving Atom and all projects under the Atom organization for an official sunset on December 15, 2022. January 30, 2023 Update: Update to the previous version of Atom before February 2 On December 7, 2022, GitHub detected unauthorized access to a set of repositories used in the planning and development of Atom. After a thorough investigation, we hav
第2回 RedPenを利用した文書の継続的検査への取り組み | gihyo.jp
今回はRedPenを利用して文書を継続的に検査する方法について解説します。文書の継続的検査環境では、執筆中の文書をGitなどのバージョン管理システムで管理します。著者が行った変更が、サーバにあるバージョン管理システムにプッシュされるたびに自動でRedPenが適用されます。 本稿では、はじめにGitなどのバージョン管理システムで文書を管理するメリットについて述べます。その後継続的インテグレーションの説明を行い、RedPenと組み合わせて文書の管理に利用してみます。 文書をGitで管理 最近は文書の管理にGitなどのバージョン管理システムを利用する人が多いのではないかと思います。私もある程度の大きさの文書はすべてGitで管理しています。昔の状態に簡単に戻れるという以外にも、文書管理にバージョン管理システムを利用すると次のようなメリットを享受できます。 マージ処理 バージョン管理システムを利用す
第1回 自動文書検査ツールRedPenとは？ | gihyo.jp
はじめに 本連載ではRedPenという自動文書検査ツールの紹介とRedPenを利用した技術文書の校正方法について説明します。RedPenはオープンソースプロジェクトで、現在もゆっくりと開発が続いています。RedPenのホームページは次のとおりです。 http://redpen.cc RedPenは技術文書をターゲットにした文書の自動検査ツールです。技術文書にはマニュアルやチュートリアル、論文、仕様書等が含まれます。この記事のようなソフトウェアツールの紹介文書はもちろん技術文書の一つといえます。第1回の今回は、はじめに技術文書の特徴を解説し、その後RedPenを開発した動機について紹介します。記事の後半では、RedPenの特徴と利用方法について解説します。 技術文書の特徴 RedPenが対象とする技術文書ですが、作文や日記、文学作品等とは大きく異なる特徴をもちます。 最大の違いは、技術文書に
RedPenを使って技術文書を手軽に校正しよう 記事一覧 | gihyo.jp
運営元のロゴ Copyright © 2007-2024 All Rights Reserved by Gijutsu-Hyoron Co., Ltd. ページ内容の全部あるいは一部を無断で利用することを禁止します。個別にライセンスが設定されている記事等はそのライセンスに従います。
RedPen Status 2014/07
This presentation covers the introduction of RedPen and the development status.
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
