やりたいことの整理

自分が試したことをメモとして残し、手軽にアクセスできるようにしたい

上記がコアコンセプトです。
それをどう膨らませたいかを箇条書きでまとめていこうと思います。

• 各種資料へのハイパーリンクを集約し、手軽にアクセスしたい
  → Google CodeLab, Microsoft Learn などとても有益な情報がいっぱいあるが、すぐ忘れてしまう……
• 画像を表示したい
• コード実装例を記述したい
• スライド資料を扱いたい
• 手順書を状況に応じて省略表示したい
  → 例えばmacOS に自分好みのモバイルアプリ開発環境を整えてみた に記載した手順を条件でフィルターしたい

自分がお世話になっているサービスとの比較

• GitHub
  • 良いところ
    • 実装と文書が一致するので分かりやすい
  • 物足りないところ
    • 開発しているもの以外のことを書くのは気が引ける……
• Qiita
  • 良いところ
    • Markdown で手軽にメモを残せる
    • スライド形式にも対応している
  • 物足りないところ
    • 記述のフィルターはできない
    • 投稿者のレベルが高い……
    • ハイパーリンクなどのまとめを投稿できるけど、気が引ける……
• Speaker Deck
  • 良いところ
    • スライド資料がいい感じに表示できる
  • 物足りないところ
    • スライドが画像扱いなので、コピペが面倒
• Twitter
  • 良いところ
    • 手軽に投稿できる
  • 物足りないところ
    • テキスト表現はあまりない
    • 文字数が制限される

自作するべきか

自分が要求する事項に対して全てを満たすものは見当たらないため、自作するのが良さそうだ。
さらに自作することで下記のメリットも見込める。

• 自分が開発・運用をしていくことになるので、実戦データの収集とスキルアップが見込める
• 自分しか使わないため、物怖じせず気軽に投稿できる

仕様の整理

機能要件

• 状況に応じて手順を省略済みのものを表示できること
• 大量のハイパーリンクを集約でき、かつ絞り込み検索できること
• 文書は下記２パターンの表示ができること
  • 記事
  • スライド形式

非機能要件？

• 動的に表示したいデータはJSON 形式で記述する
  → フィルター可能な項目を付与したい
• 文書はMarkdown で記述する
  → 画像、コード実装例、ハイパーリンクの表現が可能になる
  → スライドも解析ライブラリを使えば表現可能