Yahoo! ニュースにおけるドキュメント管理の事例紹介

167 Views

December 21, 21

スライド概要

Yahoo!ニュースにおけるコンフルエンス上のドキュメント管理の事例紹介について話をします。

profile-image

エンジニア・デザイナー向けのヤフー公式アカウント。イベント/登壇情報/ブログ記事など、ヤフーの技術・デザインに関わる情報を発信します。

シェア

埋め込む »CMSなどでJSが使えない場合

関連スライド

各ページのテキスト
1.

Yahoo! ニュースにおける ドキュメント管理の事例紹介 ヤフー株式会社 メディア統括本部 ニュース担当 後藤拓実 Copyright ©2021 (C)Yahoo 2020 Japan Yahoo Corporation Japan Corporation. All rights Allreserved. Rights Reserved.

2.

⾃⼰紹介 •2012年にヤフー株式会社へ新卒⼊社 フロントエンド寄りのエンジニア • ニュースサービス担当10年⽬ • 2018年頃から技術刷新プロジェクトに携わる 現在は ウェブ版 Yahoo! ニュースのテックリードを担当 ©2021 Yahoo Japan Corporation All rights reserved. 2

3.

今⽇お話すること シンプルなガイドラインを敷くことでドキュメントの改善が進んだ • Yahoo!ニュースにおけるドキュメントの課題 • 改善に向けて策定したガイドラインの紹介 ©2021 Yahoo Japan Corporation All rights reserved. 3

4.

ヤフーにおけるドキュメント管理事情 •全社員で1つのコンフルエンスを利⽤ • 2006年に導⼊ 15年以上稼働 • 利⽤⽤途に縛りはなく⾃由に使える • 組織、プロダクト、プロジェクト、個⼈等の様々な単位 • メモ書きから⼿順書、議事録、組織情報など ©2021 Yahoo Japan Corporation All rights reserved. 4

5.

Yahoo! ニュースの組織 • 全職種含めておよそ200⼈ • プロジェクトやプロダクト等の数⼗のチーム • 表向き1サービスだが異なる組織の合流の歴史 そんな中、以下のようにコンフルエンスが使われていた • 基本的に1つのスペース配下に全チームのドキュメントを集約 • チームかシステム毎にポータル的なページがあり、 そのページ配下に関連する⽂書を⾃由に作っていく ©2021 Yahoo Japan Corporation All rights reserved. 5

6.

ドキュメントに関しての2018年頃の課題感 • スペース直下やチーム毎のページ直下にどんどんページが追加される • チーム内外問わず階層構造や⾒出しが整理されていない・統⼀感がない その結果、 • 辿りづらいのでブックマークしたり、⾃分⽤のリンク集を作ったりしがち • 資料が⼀時的な情報なのか、最新の情報なのか分かりづらい • ドキュメントを探す範囲が広くなりがちで時間を無駄にしてしまう • 整理されている感じがしないため探すときの⼼理的ハードルが⾮常に⾼い ©2021 Yahoo Japan Corporation All rights reserved. 6

7.

なぜこうなるのか •広く適⽤できるような明⽂化された管理の⽅針がなかった • サービス内の組織横断で統⼀を働きかける機会がなかった • 致命的なボトルネックではないので問題とならなかった ©2021 Yahoo Japan Corporation All rights reserved. 7

8.

改善に向けての取り組み • ドキュメント管理のガイドラインを作成 • 2018年頃からの技術刷新の取り組みに合わせて適⽤ ©2021 Yahoo Japan Corporation All rights reserved. 8

9.

どのようなガイドラインか 構造と⾒出しについてのシンプルなルール ① ページを3種のページ種別から構成する • ページの種類はポータル、リスト、コンテンツの3つ ② ページ⾒出しの命名規則を守る ©2021 Yahoo Japan Corporation All rights reserved. 9

10.

①3つのページ種別 ポータルページ ファーストビューを重視した配下ページへのハブとなるページ リストページ コンテンツページをリスト化するためのページ コンテンツページ 実際に作業記録や議事録等の資料を書くページ ©2021 Yahoo Japan Corporation All rights reserved. 10

11.

3つのページ種別による階層下の例 ©2021 Yahoo Japan Corporation All rights reserved. 11

12.

3つのページ種別による階層下の例 ©2021 Yahoo Japan Corporation All rights reserved. 12

13.

ポータルページ 作成単位 • プロダクトやプロジェクト、案件といった任意の単位で作成 • ポータルの直下にポータルを設置することも可能 ページ内容 • 概要情報や配下のドキュメントを⾒つけやすくするためのページ。 • ポータルとしての機能が重要なので⾒やすさを優先して⾃由に構成して良い • ポータルの直下はリストかポータル ©2021 Yahoo Japan Corporation All rights reserved. 13

14.

ポータルページの画⾯構成の例 ©2021 Yahoo Japan Corporation All rights reserved. 14

15.

リストページ 主にコンテンツページをまとめる階層を作るページ 作成単位 • コンテンツページの種類ごと(議事録、作業記録、⼿順書、設計書など) 内容 •⼦ページマクロ等を使い、配下にあるコンテンツページを⼀覧にしておくと良い • リストの直下はコンテンツページに限らず、同様なものが並んでいれば良い。 例えば、プロジェクトのポータルページが並ぶようなパターンもあり得る ©2021 Yahoo Japan Corporation All rights reserved. 15

16.

リストページの画⾯構成の例 ©2021 Yahoo Japan Corporation All rights reserved. 16

17.

コンテンツページ 基本的にフリーフォーマットだが、以下は必須 ⽬次 • ⽂書の先頭で⽬次マクロを使い内容を俯瞰できるようにする • ⾒出しはh1から順番に正しく使う 概要 • ページの概要を簡潔に書く ©2021 Yahoo Japan Corporation All rights reserved. 17

18.

コンテンツページの画⾯構成の例 ©2021 Yahoo Japan Corporation All rights reserved. 18

19.

②ページ⾒出しの命名規則 基本 • 親ページの⾒出しに該当ページのタイトルを半⾓スペース区切りで繋げる • ポータルページでは上記を無視して名称の階層をリセットして良い ⽇付 • ⼀時的なドキュメントには⽇付を⼊れる(次ページで補⾜) • ⽇付のフォーマットはyyyy/mm/ddとする ©2021 Yahoo Japan Corporation All rights reserved. 19

20.

⾒出しにおける⽇付の考え⽅ 保守していく資料なのか⼀時的なものなのかどうかによって⽇付を⼊れる 保守しないページには⽇付を⼊れる • 作業記録や議事録など、作成後に更新しないドキュメントが対象 • 作成する多くの資料は⼀時的なものであることが多い 保守していくページには⽇付を⼊れない • 設計書や⼿順書など、ページを作成後も保守するドキュメントが対象 ©2021 Yahoo Japan Corporation All rights reserved. 20

21.

コンフルエンスのページ⾒出しの制約 同⼀スペース内で複数ページに同じタイトルは設定できない ガイドラインでは親ページの名前を受け継ぐ命名にすることでこの制約を回避 NG OK ©2021 Yahoo Japan Corporation All rights reserved. 21

22.

③⾒る⼈の⽴場になって書く ⽬次をつける • ドキュメントの全体構成を俯瞰できるように ⾒出しレベルを正しく使う • ⽬次をただしく出すためにh1から適切に使う • スタイルを変えるために使わない(少し太字にしたいからh5を使うなど) ©2021 Yahoo Japan Corporation All rights reserved. 22

23.

ガイドラインのポイント シンプルなルール •ガイドラインを知らなくてもパターンが想像でき⾒様⾒真似でルールを守れる •こだわりが⽣まれやすいポイントの排除(⽇付フォーマット、区切り⽂字等) リスト構造と命名規則によりパターンが⽣まれる •パターンを認識できると整理されているように感じ、未知のドキュメントでも 探せる気になる。 ©2021 Yahoo Japan Corporation All rights reserved. 23

24.

ガイドラインの浸透と継続のTips プロジェクト開始時などの最初に⼟台を作ってしまう • 綺麗なところを汚そうとする⼈は少ない。⾒様⾒真似はしてくれる。 • 「作業記録」の置き場所をまず作ってしまう 定期的なガイドラインの共有 • 期初のキックオフ等の時にガイドラインを改めて共有する • 新しく⼊社した⼈にも都度伝える 定期的なメンテナンス • ガイドラインに沿ってないページを⾒つけたら適切な階層に移動・リネームする ©2021 Yahoo Japan Corporation All rights reserved. 24

25.

ガイドライン作成後の現在(個⼈的な感想) チームを超えてドキュメントに統⼀感が⽣まれてきている • 技術刷新が進むに連れ複数のチームでドキュメントの改善が進んだ • 想像がつくようになり他チームのドキュメントでも辿りやすくなった どうあるべきか判断できるようになった • 整理されてない無造作に作られたページは全てコンテンツページ • 妥当なリストページ配下に移動してリネームすることで整理が進む ©2021 Yahoo Japan Corporation All rights reserved. 25

26.

EOP ©2021 Yahoo Japan Corporation All rights reserved. 26