application - Githubissues

muent-ds / code2log

0 stars 0 forks source link

application #4

Open KITA-DS12 opened 8 months ago

KITA-DS12 commented 8 months ago

アプリの機能・デザイン等についてメモ・議論するところ

KITA-DS12 commented 8 months ago

概要

開発におけるドキュメント化・ブログ化を支援するプロダクト

機能

エディタ
- マークダウンエディタ
- テンプレート生成
- できればコンテンツ生成
- 最低限ドキュメントを自動生成できると嬉しい
- 各ブログへのアウトプット
- Qiita, Zennに投稿しやすい形であれば良い
開発作業の保存 (commit, PR)
閲覧したサイトの保存

KITA-DS12 commented 7 months ago

最低限のワンパス

ログイン認証 (ほぼBE)
- 形式は問わない
- GitHub認証を使えばPrivateリポジトリも扱えるのでできればそうしたい
- ログイン自体をGitHubにするのか、連携という形を取るかは問わない
指定したリポジトリのログを取得・送信(BE)
- 最低限 : CommitやPRのリンクを送信する
- できれば : コード差分などを送信する
- GitHub API等を用いる
リポジトリ単位で閲覧したURLを保存・送信(BE)
- UIは後から考えるとして、ひとまずBEで処理
マークダウンエディタ (FE)
- リアルタイムプレビュー
- マークダウン出力(コピペ・ファイルダウンロード)
受け取った作業ログ・サイトリンクを挿入する機能(FE)
マークダウンコンテンツ(長い文字列)の保存
- テキストをDBで保存するか、S3などのストレージサービスで保存するか要議論