GitHubにPushする前に記法チェック「Github Preview」
Github PreviewはMarkdown、textile、rdoc、org、creole、MediaWiki記法のリアルタイムプレビューがついたWebテキストエディタです。
GitHubのREADMEではMarkdownやTextile、RDocといった各種記法が利用できます。可読性も記述もしやすい記法とは言え、書いてPushして確認したら間違っていた…なんていったらショックなはずです。そこで使いたいのがGithub Previewです。テキストエリアで各種記法の記述、プレビューができます。
左側に入力するとリアルタイムに右側にHTMLへの変換結果が表示されます。
記法のヘルプもついています。
他の記法に変更することもできます。
Textileの記法ヘルプです。
対応しているのはMarkdown、textile、rdoc、org、creole、MediaWiki記法となっています。
Github PreviewはGitHubでREADMEに使える記法を一通りサポートしています。またそれらはプログラマーにとっては一般的な記法も多いので、GitHub以外でのドキュメント記載の際にも入力補助として使えるでしょう。
Github PreviewはRuby/Sinatra製のソフトウェア（ソースコードは公開されていますがライセンスは明記されていません）です。
MOONGIFTはこう見る
Wikiにしても同様ですが、HTMLを直接書くのは苦手にしている人にとって特定の記法に沿って書くことで自動変換してくれる仕組みというのは便利です。ただし記法を覚えるというのは相当な負担になります。特に書いて間違っていたりすると大きなストレスになってしまうでしょう。
それを防ぐためには入力補助が有効です。WYSIWYGなエディタをつける（しかし大抵これが嫌で記法を使っているのですが）、リアルタイムプレビューをつける、記法のヘルプを表示すると言った具合です。いずれの方法が有効かは利用者のリテラシーによって異なるでしょう。