見出し画像

ドキュメントサイトもプロダクトの一部だと気づいた1年でした。 Kurocoドキュメントチーム、2021年の活動まとめ

Koshi Kagawa

こんにちは。賀川と言います。
現在はディバータ社にてヘッドレスCMS 『Kuroco(クロコ)』のドキュメントサイトのプロジェクトマネージャーとテクニカルライターをしています。

今年はひたすらこのKurocoの業務に取り組んでいました。

Kurocoですが、2021年の4月に正式ローンチしました。ドキュメントサイト自体は2020年の12月頃から始動していたので、ちょうど１年程経過しています。なので今回のnoteでは、ドキュメントチームのこの1年の活動内容をまとめてみようと思います。

2021年の活動内容

それでは2021年の活動内容です。

書いたドキュメント数：405ページ

2020年12月24日現在で掲載しているドキュメントは405ページでした。

405ページ、1日1ドキュメント以上をリリースしているのでペースとしては良いのではないかと思います。ページの内訳としては ->

言語

  • 日本語：302ページ

  • 英語　：103ページ

カテゴリ

  • チュートリアル　　：85ページ

  • 管理画面マニュアル：164ページ

  • リファレンス　　　：15ページ

  • FAQ　　　　　　　：120ページ

  • その他　　　　　　：21ページ

今年はとにかく書くこと（量）に集中しました。
Kurocoはリリースしたばかりなので機能の追加や改善は日々行われます。エンジニアに確認し、検証し、ドキュメントに落とす、というのをひたすら対応していました。チュートリアルで基本的な利用シーンを描き、リファレンスで細かく説明する、という流れで書きました。

ドキュメントの作成者ですが、最初はサポートチームを中心に対応していました。徐々にエンジニアチーム、PMチームの方々にも書いていただいております。ドキュメントはGitHubで管理しているので、書きたいドキュメントは随時issue化し、書いたらプルリクしてもらってます。

（余談ですが、ほぼ全社員がGitHub利用できるのは結構すごいことなんじゃないかと思ってますが、いかがでしょう。）

プロジェクトWIKI作成

書く側がなるべく迷わずドキュメントを作成できるように、ドキュメントで迷ったら確認できるWIKIを作成しました。

スタイルガイドや、ドキュメントの作成方法、困った時はどうするか、などをまとめています。

サイトデザインの改修

元々はメディアサイトっぽいデザインを利用していたのですが、どうもドキュメントを探すには使い難く、現在のサイトのように改修しました。

旧デザイン

2021年5月くらいまでのデザイン

新デザイン

トップページ
詳細ページ

だいぶドキュメントが探しやすくなったかと思います。

改修についてですが、最初の頃は私がNuxt.jsをちょこちょこいじっていたのですが、さすがに無理が来たので社内デザイナーチームにお願いしました。
おかげでメニューリンクが充実したり、ページ内リンクができたり、アルゴリアを導入したりと、サイトが強化していきました。やはりデザインの力は偉大です。

KurocoサポートSlackの開設

サポートの一環として、Slackにてサポート対応をはじめました。現在はほぼ全ての回答に代表の加藤さんが回答しています。

いただいた質問からドキュメント化するので、ご質問やご要望はこちらからご連絡ください。

以上、2021年の大きなトピックとしてはこのようなことを実施してきました。


2022年対応したいこと

次に2022年の目標です。

もっと探しやすいサイトへ。サイトデザインの改修

ドキュメントサイトで一番大事なことは、探しているドキュメントをすぐ見つけることができるということです。そのためにはまだまだやることがたくさんあると思っています。
もっと探しやすいデザインへ改善していくようにします。

英語ドキュメントを増やす

Kurocoはグローバルマーケットでも展開していきたいと思っています。そのため、英語ドキュメントの充実は必須です。
日本語ドキュメントに対して、英語ドキュメントは現在30%程度です。11月からは英語のテクニカルライターにも参加いただき、徐々にドキュメント数を増やしています。来年前半にはドキュメント数を日本語と英語同じにし、英語の方がリードできるように持っていきたいと思っています。頑張りましょう。

また、単純に日本語を英語に翻訳するということではなく、文章のクセや文化を取り入れた英語かにしていきたいと思います。Notionが日本語化された時に伝えられたメッセージ『Translationではなく、Localization。』を胸に刻み対応していきたいです。

レビューの一部自動化

textlintの導入を進めています。ドキュメント数も増えてきており、ルール化もできてきています。ここら辺でtextlintを導入し、自動化できる箇所はどんどん自動化しようと思います。

幸運なことに、textlintについてはさまざまな企業の取り組みがドキュメント化されています。先人たちの知恵に感謝しながら、良い部分を積極的に取り入れていこうと思います。



以上、2021年のまとめと今後やりたいことです。
皆さんの一年はいかがでしたか？ぜひいろいろお話しを聞きたいところです。

ユーザにとってみると、『本当はドキュメントなんて読みたくない』『プロダクト操作が簡単になれば良い』というのが本音というのは分かります。しかしながら、それはそう簡単なものではありません。むしろ不可能だと思います。

プロダクト操作に困ったときに補足的にスッと提出し素早く解決に導いてくれるもの、それがドキュメントの目的だと思います。トータルのユーザー体験で考えると、プロダクトとドキュメントはセットだと考えます。そういう意味では、ドキュメントもプロダクトの一部だと感じます。ここを意識しながら、より良いプロダクト作りに貢献していきたいと思います。

以上、今年のまとめと来年の目標でした。
私個人としては、これから冬休みを取ります。家族と温泉に行き、雪の公園で遊び、本を読み、ひたすらぼーっとしたいと思います。
皆様の2022年が素敵な年になるよう祈っています。それではまた来年！


いいなと思ったら応援しよう！

Koshi Kagawa
読んでいただきありがとうございます。