タグ

2018年1月7日のブックマーク (2件)

  • Atomとtextlintで始めるその場で文章校正ができる環境の作り方 | DevelopersIO

    こんにちは。サービスグループの武田です。 AWS re:Invent 2017が開催されますね。弊社からは実に34人が現地に乗り込みます。 AWS re:Invent 2017、クラスメソッドは34人が現地参加!そして全社員でイベントを盛り上げます! #reinvent 今年はお留守番ですが、来年は行きたいと今から狙っています。 さて、弊社はブログの執筆を仕事の一環としてとらえており、毎日たくさんの記事が公開されています。 記事を書く際には、内容はもとより、誤字脱字・表記ゆれにも気を付ける必要があります。 今回は文章のチェック・校正を楽にするためのツールとして、以前から気になっていたtextlintを使ってみましたので紹介します。 もちろんこの記事も、textlintを使って書いています。 環境 macOS Sierra Atom Node prh textlint textlint-ru

    Atomとtextlintで始めるその場で文章校正ができる環境の作り方 | DevelopersIO
  • RedPen でわかりやすい技術文書を書こう | DevelopersIO

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

    RedPen でわかりやすい技術文書を書こう | DevelopersIO