Wantedly Engineering Handbook

新しく Wantedly の開発チームに参加する人向けのドキュメント集です。社内のエンジニアが知るべき情報のうち外部にも公開できる情報を体系的にまとめたものです。

入社前後のフルタイムの社員が一番の想定読者です。ハンドブックの内容はインターンや採用選考を受けている人にも役に立つことを期待しています。また、PDF 形式の電子書籍およびオンラインドキュメントとして広く一般公開しています。1 年に 1 度、物理書籍としても印刷し社内外に配布します。

入手

• 🌏 公開版 PDF (技術書典)

• 🔒 社内版 PDF (internal)

• 🌐 Web 版

• 📚 過去の TechBook

関連資料

• 📊 Wantedly の開発チームをよく知ってもらうための 2W1H

• 🎤 登壇資料一覧

• 🎧 Podcast

• 🍿 YouTube

• 🛋 Blog

• 🇬🇧 Blog (English)

• 🇬🇧 Blog (English - dev.to)

• 💬 Twitter

• 🏫 wantedly/learning-resources

• 📚 dev-docs (internal)

• 🔰 Wantedly 入門 (internal)

• 📚 Confluence (internal)

Dashboards

• Looker (internal)
• SLO/SLI (internal)
• Argo CD (internal)
• Argo Workflow (internal)
• Loki (internal)
• New Relic
• Datadog

目次

• まえがき

第一部：開発チームへの案内

• 技術とアーキテクチャ
• プロダクト概要

• 開発チームの構造
• コミュニケーションの全体
• ドキュメンテーション

• カレンダー
• 障害対応の心構え
• 効率的な社内知識の調べ方
• 外部発信(執筆中)

第二部：技術領域への案内

Apps

• アプリを提供するプラットフォーム
• デザインシステム入門
• Web アプリのアーキテクチャ
• プロダクトデザイナーと上手に協働するための心得
• Web アプリのデザインシステムライブラリ
• Web アプリ共通ライブラリ "React Shared Component" の紹介
• モバイルアプリのアーキテクチャ
• モバイルアプリのデザインシステムライブラリ

The System

• protobuf スキーマと gRPC 通信
• 実践: gRPC in Ruby
• 実践: gRPC in Go
• GraphQL Gateway - アプリ向けに API を公開する
• Wantedly Visit で BFF GraphQL サーバーを辞めた理由
• 実践: GraphQL スキーマ設計(未執筆)

• API での認可処理 (Authorization)
• マイクロサービス共通ライブラリ "servicex" の紹介
• 非同期メッセージング処理入門(未執筆)

• バッチ処理入門(未執筆)

Infrastructure

• プロダクト開発のための Kubernetes 入門
• インフラ構成概要
• リリース・デプロイ戦略を支える技術
• SaaS を活用する：New Relic, Honeybadger, Datadog

Data

• データ基盤入門
• レコメンデーション
• Looker 入門
• 推薦システムの開発に使っているツール

開発プロセス

• Git の慣習
• ポストモーテムの取り組み
• 負債返済日の取り組み
• プロダクトの課題発見及び解決
• ソフトウェアデザインの基礎
• コードレビュー
• コーディング規約
• リリース・デプロイ戦略
• 上長承認が必要な作業
• アーキテクチャディシジョンレコード(ADR)
• 作業ログを残す意味
• 多言語化対応(i18n)
• メール開発

開発ツール

• 社内利用している開発ツールの最新状況
• kube
• Code Coverage
• Kubefork

おわりに

• ロードマップ(未執筆)

• Handbook の書き方
• コントリビューター

付録

• 社内用語集
• 主要な GitHub レポジトリのリスト(未執筆)

• 今後の挑戦・未解決イシュー(未執筆)

• プロダクト開発組織のバリュー(未執筆)

• 採用についての考え方(未執筆)

コントリビューションガイド

ハンドブックは、継続的にチーム全員で更新していきます。特に、新人のみなさんの積極的な貢献を望みます。自分自身が困ったことや、ドキュメント不足に気づいた情報を、未来の仲間のために書き残してください。 既存の更新案は Wantedly Engineering Handbook で管理されています。

情報の追加・更新や誤字脱字

修正の pull request を歓迎します。@engineering-handbook-editorsにレビューをアサインしてください。

新しい記事の執筆

目次の中でリンクが存在しない記事は未執筆です。少しでも情報があれば助けになります。短い文章や、GitHub issue の抜粋でも構わないので、関連しそうな情報を教えて下さい。記事を書いて pull request をだすのも、もちろん歓迎です。

また、現時点で目次に含まれていないトピックに関しても、新しい記事の提案を歓迎します。気軽にissueを作成してください。

新しい記事を作成し、書籍版に含められる内容になったら、catalog.ymlに追加してください。

記事の文章フォーマットに関しては、Handbook の書き方を参照してください。