RedPen でわかりやすい技術文書を書こう | DevelopersIO
最近はブログを始めマニュアルや仕様書など技術文書を書く機会が多くなってきました。 技術文書はわかりやすさが重要だと思うのですが実際は書けていません。 どうしたらわかりやすい文書が書けるのだろうか？と調べていたら RedPen というツールを見つけたので早速試してみました。 RedPen とは？ RedPen とはプログラマや記者が規約に従って文書を記述するのをサポートしてくれるオープンソースのソフトウェアツールです。 プログラミングが規約に従ってコーディングされているかチェックするように、RedPen は自然言語で記述された入力文書の検査を自動化してくれます。 RedPen の特徴 設定が柔軟に行えます。（カスタマイズも柔軟） どのような言語で書かれた文書でも処理できます。（もちろん日本語も OK です） Markdown や Textile フォーマットで記述された文書をそのまま検査でき
自動文書検査ツールRedPenをRubyから使えるredpen-rubyを書いてみました - Fuzoku実践入門ブログ
最近、RedPenという技術文書向け校正ツールを知りました。RedPenについては、RedPenを使って技術文書を手軽に校正しよう：連載｜gihyo.jp … 技術評論社に詳しい説明があります。 本格的に文章を書くようになり、こういったツールを求めていたため、早速試してみることにしたのですが、epubcheckをepub_validatorを使っている身としては、RedPenもRubyから使いたいなぁと思ったので、折角なので最近覚えたRubyを使ってepub_validatorのコードを参考にラッパーツールを作ってみることにしました。 RedPenRuby is a Ruby wrapper for redpen: a text inspection tool. akinomurasame/redpen_ruby redpen_ruby | RubyGems.org とりあえず、希望する動
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
