category

仕様書なども GitHub のソースと管理してみようかとかとか

2022-08-08

プロジェクトの進行時に開発内容の仕様書とかドキュメントを書くことがあるわけだけど。
普段は Google Docs が多くて、他だと Docbase を使うことが多い。

テンプレートとか GitHub で管理するんだから GitHub のリポジトリにドキュメントを入れておいた方が楽かもしれないなぁと思うことがここ最近ある。

こんな感じで markdown ファイルだと heading にあわせて目次が自動ででてくれるのとか全く知らなかった（恥

20220807 1147
基本的な書き方とフォーマットの構文 - GitHub Docs
https://docs.github.com/ja/get...

GitHub の wiki だとリポジトリで管理できるけど、ブランチ分けるとかプルリクとかはできないからコードとしてドキュメントもいれるかんじで。

1つのリポジトリにコードもドキュメントもあると使いづらいのかなぁとかとか気になるところもあるが。

色々試行錯誤して決めていきたいところだ。