プロダクトのヘルプサイトをマークダウンに移行した話 - Cybozu Inside Out | サイボウズエンジニアのブログ

こんにちは！開発部テクニカルコミュニケーショングループの仲田です。 皆さんマークダウン使ってますか？（唐突） 文書記法の一つで、プログラマーにとっては馴染みがあるものだと思います。サイボウズのプロダクト仕様書もマークダウンで書かれることが多くなっています。 ですが、公式ドキュメントを作る用途として採用される例はまだ少ないように思います。数ヶ月前になりますが、プロダクトのヘルプサイトをマークダウンに移行しましたので、今回はその話をします。 なぜ移行したのか マークダウンに移行した動機は、一言で言うとヘルプサイトの制作や更新を効率化するためです。 サイボウズでは、プロダクトのアジャイル開発化を進めています。アジャイル開発では、ウォーターフォール開発と比べてリリース間隔が短縮されます。パッケージ製品がメインだった頃には、リリースは年単位で、短くても数ヶ月ごとというスパンでした。ところが、クラウド

[rti7743]

markdownをビルドするのは本来はwikiの仕事だと思うんだけどなあ・・・

[satoshie]

頭良い。これやりたい。

[Fivestar]

以前作ったサービスでMarkdown使ったヘルプセンター導入したら使い勝手よかったのでよいです

[ryuzee]

マニュアルやヘルプは定型化しやすいのでマークダウン向きだし、テキスト化されるとバージョン管理と相性良くなるので、みんな真似するとよいのでは。

[progrhyme]

Hugo使ってるんですね