タグ

関連タグで絞り込む (2)

タグの絞り込みを解除

redpenに関するdecoy2004のブックマーク (2)

  • 文書執筆の指南書で解説されている問題点を RedPen で発見する

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

    文書執筆の指南書で解説されている問題点を RedPen で発見する
    decoy2004
    decoy2004 2016/06/21
    漢数字と数字の混在、日付の書式不統一、「為」と「ため」 「等」と「など」の不統一、なども検出できるといいな。
  • RedPen でわかりやすい技術文書を書こう | DevelopersIO

    最近はブログを始めマニュアルや仕様書など技術文書を書く機会が多くなってきました。 技術文書はわかりやすさが重要だと思うのですが実際は書けていません。 どうしたらわかりやすい文書が書けるのだろうか?と調べていたら RedPen というツールを見つけたので早速試してみました。 RedPen とは? RedPen とはプログラマや記者が規約に従って文書を記述するのをサポートしてくれるオープンソースのソフトウェアツールです。 プログラミングが規約に従ってコーディングされているかチェックするように、RedPen は自然言語で記述された入力文書の検査を自動化してくれます。 RedPen の特徴 設定が柔軟に行えます。(カスタマイズも柔軟) どのような言語で書かれた文書でも処理できます。(もちろん日語も OK です) MarkdownTextile フォーマットで記述された文書をそのまま検査でき

    RedPen でわかりやすい技術文書を書こう | DevelopersIO
    decoy2004
    decoy2004 2016/03/27
    校正ツール
  • 1