技術記事サイトのTech.museumとは

いきなりですが、こんな経験はありませんか！？

• 参考にした技術記事が古くてやり方が変わっていた🥺
• 参考にした技術記事の内容が間違っていた😭

これらの問題を解決するために、私たちはOSS(Open Source Software)の仕組みを活用してみんなが著者であり、読者である技術記事サイトTech.museumを開発しました。

従来の技術記事サイトの問題

• 記事の内容が古いままである
• 記事の内容が間違っている
• 勝手に記事が削除される
  etc...

どうやって解決するのか？

• 記事の内容が古い
  OSS形式で記事を作成することで、誰でも記事を編集できるようになります。そのため、記事の内容が古くなっていた場合でも、気づいた人が新しい情報に更新することができます。

• 記事の内容が間違っている
  記事を投稿する際にプルリクエストを挟みレビューを受けることで、間違いを含んだ記事を公開してしまう可能性を抑えることができます。

• 勝手に記事が削除される
  中央集権ではなく、みんなが記事を作成・編集できるOSS形式でのオープンな運営することで、勝手に記事が削除されることを防ぎます。

Tech.museumの優れている点

• 記事の質を保ちやすい
• 自分が書いた記事をレビューしてもらえる
• オープンな運営なので、記事が勝手に削除されるなどの事がおきない
• OSSコントリビュートの練習にもなる

記事投稿までの流れ

1. このリポジトリをフォークします。
2. フォークしたリポジトリをクローンします。
3. 記事を作成
4. プルリクエストを作成
5. レビュー受け、必要があれば修正を行う
   3番以外は、従来のOSSへのコントリビュートと同じですね！
   ここでは3番の記事の作成について詳しく解説します。

記事の作成

Tech.museumでは記事の雛形を生成するコマンドラインツールが用意されているので、それを使って記事を作成します。

pnpm run gen:articleコマンドを実行する

pnpm run gen:article

上記のコマンドをターミナルで実行すると以下のような出力がされます。

記事のトップカテゴリを選択する

上記の画像では、

• backend
• frontend
• git
• infra
• mobile
• tech-museum
  のカテゴリがあります。
  もし、これらのカテゴリに当てはまらない場合は、一番下にあるCreate new folderを選択して新しいトップカテゴリを作成します。
  今回の例ではmobileを選択します。

記事のサブカテゴリを選択する

記事のタイトルを入力する

生成した記事の雛形を編集

---で囲まれた部分は、記事のメタ情報です。
メタ情報は以下のようになっています。

• title: 記事のタイトル(例：Android Wear OS開発の基本)
• description: スマートフォン向けの開発との違いを確認しつつ簡単なWearOSのアプリを開発します。
• keyword: 記事のキーワード(例：Android, WearOS, Kotlinなど複数可)

まとめ

Tech.museumは従来の技術記事サイトの情報が古いや間違っているといった問題を解決する事ができます。
また、OSSの仕組みで記事を投稿するのでOSSコントリビュートの練習にもなる！