izm
fanbox
製品ドキュメントサイトをどうやって作るのか問題
🕑 Added 2020-06-16 15:51:32 +0000 UTC世の中に製品をお出しするときには、大体ドキュメントを整備する必要があります。
僕はGithubが無いと何も出来ない体になってしまっていて、GoogleDocumentを使って製品ドキュメントを管理できる自信がまったくありません。
出来れば
・Github上のpublic repositoryでmarkdown形式のファイルを管理しながら
・生成したサイトがpublicになって
・ユーザのフィードバックがissueやpull reqで受け付けやすい
みたいなものがほしいところです。
Gitbook,Jekyllとかを検討しましたが、そこそこ大変というか、流し読みしたり検索する事が多い製品ドキュメント向けのカスタムは大変な予感があります。
理想を言うと
プロダクトのドキュメントにプルリクエストを送れる仕組みがすごい
https://qiita.com/amay077/items/8823376f307235a7f651
で例示されている便利な仕組みが世の中にあるので、似たようなサービスが無いかなあと思って探したら無い。
困りましたね。
あまりjavascriptは得意では無いですがDocusaurus v2を試しに触ってみようかなあと思っています。
https://v2.docusaurus.io/
（それにしても「このページの修正依頼を送る」みたいな機能がついたGithubフレンドリーなドキュメントジェネレータ、何か無いものかしら）
（Docusaurusにはあります）
（今はGithubリポジトリ上のwikiを使っていたのですが、これは公開用には向いていない、と思っています）
Comments
markdownそのものだと、Githubホスティングビリティが低い（GithubPagesという手はアリ）かな、と思っていました。なるほど
桃芭蕉実🍑🍌
markdownで十分だと思いますー！
