Private Cloudを支える最高のユーザーガイド運用技術

社内サービスにおけるメンテナブルなドキュメント運用についてお話します。

1. Private Cloudを支える “最高”のユーザーガイド運用技術 Shin Ando / @andoshin11
2. Shin Ando • @andoshin11 • Ex-Frontend / Backend / DevOps Engineer • BizDev at LINE Corporation • Verda Customer Relation Committee Lead
3. 昨日ちょっとバズったやつ
5. LINE開発者が利用するPrivate Cloud基盤 2021.02現在
6. Verda CRC Customer Relation Committeeとは？ • Verdaは社内サービスとはいえ、Potential Userは2,500+名 • Verdaの構成メンバーはインフラエンジニアがほとんど • CRC = クラウド基盤の価値を最大化するための組織 ◦ User Guideの運用補助・コンテンツディレクション ◦ Release Notesのデリバリー設計 ◦ Service Roadmapの提供 ◦ RFC Processの設計 ◦ サポートオペレーション最適化・顧客の利用状況の分析 ◦ etc...
7. Verda CRC Customer Relation Committeeとは？ • Verdaは社内サービスとはいえ、Potential Userは2,500+名 • Verdaの構成メンバーはインフラエンジニアがほとんど • CRC = クラウド基盤の価値を最大化するための組織 ◦ User Guideの運用補助・コンテンツディレクション ◦ Release Notesのデリバリー設計 ◦ Service Roadmapの提供 ◦ RFC Processの設計 ◦ サポートオペレーション最適化・顧客の利用状況の分析 ◦ etc... 今日はここの話をします
8. 最高のUser Guide運用 スケールする 開発支援技術 高品質なコンテンツ を維持するカラクリ アクセシビリティを 最大化するCDと基盤 DX Testing Deployment
9. 01DX - Developer Experience - スケールする開発支援技術
10. Developer Experience
11. Developer Experience SSG可能なNuxt ContentでMarkdown Fileを管理
12. Developer Experience
13. • 非Node.jsエンジニアが編集環境を立ち 上げやすいよう、Docker Imageを用意
14. • 非Node.jsエンジニアが編集環境を立ち 上げやすいよう、Docker Imageを用意 • タスクランナーにはMakeを利用
15. • 非Node.jsエンジニアが編集環境を立ち 上げやすいよう、Docker Imageを用意 • タスクランナーにはMakeを利用 • 効率的なコンテンツレビューを行うため のPR Template
16. • 非Node.jsエンジニアが編集環境を立ち 上げやすいよう、Docker Imageを用意 • タスクランナーにはMakeを利用 • 効率的なコンテンツレビューを行うため のPR Template • Contributorを増やすための Development Guide
17. 02Testing 高品質なコンテンツを維持する カラクリ
18. Linting
19. Linting typoの検知 + より良い記述の提案
20. Visual Regression Testing ✖
21. • contentsディレクトリのファイル構成から URLを生成し、対象ページのキャプチャ を撮影するクローラーを自前で用意
22. • contentsディレクトリのファイル構成から URLを生成し、対象ページのキャプチャ を撮影するクローラーを自前で用意 • CI上でreg-suitによるpixel by pixelの画 像回帰テストを実行
23. • contentsディレクトリのファイル構成から URLを生成し、対象ページのキャプチャ を撮影するクローラーを自前で用意 • CI上でreg-suitによるpixel by pixelの画 像回帰テストを実行 • キャプチャ画像の保存にはVerda Object Storageを利用 (S3 API Compatible)
24. 03Deployment アクセシビリティを 最大化するCDとインフラ基盤
25. Hosting Environment
26. Hosting Environment Manifest Repo 1. Webhook 2. Push Image Drone CI harbor 3. Update Manifest 4. Webhook 5. Update Nginx Pod Argo CD User Guide Pod User Guide Repo Ingress Controller Verda User 6. Pull Image CRC Cluster
27. Indexing on Elasticsearch
28. • Markdownからコンテンツ情報とmeta情 報をパースしてElasticsearchにバルク インサート
29. • Markdownからコンテンツ情報とmeta情 報をパースしてElasticsearchにバルク インサート • ネイティブのSearch Box(client fuzzy search)をscoringベースのESバックエ ンドに差し替え → 検索精度向上
30. • Markdownからコンテンツ情報とmeta情 報をパースしてElasticsearchにバルク インサート • ネイティブのSearch Box(client fuzzy search)をscoringベースのESバックエ ンドに差し替え → 検索精度向上 • 全文検索APIをカスタマーサポートにも 利用予定(開発中)
31. おまけ
32. Other Works プレビュービルド Staging Env モニタリングツールを利用し たアクセス・行動分析 Analytics 英語/韓国語/日本語 i18n 積極的なNuxt Contentへの コントリビュート + patch運用 OSS 顧客満足度サーベイの実施 RFC Process Community 全員参加型の改善提案 アクティビティ Workshop
33. ユーザーと開発者の”楽しい”のために
34. Thank you!!