WESEEK Tech Blog

WESEEK のエンジニアブログです

GROWI のユーザーズガイドをリニューアルしたお話

WESEEK の kouki です。GitHub 個人アカウントは kaishuu0123 で活動しています。

今回は SEROKU からの引用ではなく、オリジナル記事として「GROWI のユーザーズガイドをリニューアルした話」を書かせていただこうと思います。

ドキュメントサイトはこちらです: https://docs.growi.org

リニューアルしようとしたモチベーション

WESEEK では最近 GROWI.cloud をリリースいたしました。

growi.cloud

GROWI.cloud リリース以前では、Geek な方たちが GROWI を触っているという状況で、Issue も上げてもらいつつ、ポジティブなご意見をいただいて、特定のクラスタで盛り上がりを見せていました。

しかし、今後 GROWI.cloud と共に GROWI のコミュニティを広めていくには Geek な方も含め、 GROWI でページを書く側に寄り添ったドキュメントが必要になるだろうと考えました。

そこで、ユーザーズガイドのリニューアル提案に至ったわけです。

高尚なことを掲げていますが、正直なところ 「GROWI の機能一覧を紹介する場所を自分が作りたかった」というのが本音だったりします。 「こんな機能があったんだ~」と後になって気付くより、俯瞰して機能を把握する方が使っていて楽しいので。

提案からリニューアルまで

提案フェーズ

まずはメインコミッターである弊社武井に対して、提案ページを見せるところから始めました。

dev.growi.org

ついでに一応 GROWI はオープンなものなので、自身のアカウントでも呟いてみたりもしました。

そこから意外にもサラッと OK をもらいました。(口頭でですが)

リニューアルフェーズ

ここからは単純作業ですが、スクショを撮って、ガリガリとドキュメントを書いていきます。 リニューアル以前は「管理者ガイド」相当は無かったので、まずは以前の「ユーザーズガイド」を「管理者ガイド」に移動し、 中のコンテンツを充実させていく作業を進めました。

変更が大きくなるため、作業途中の様子を見てもらうために、タイトルに [WIP] (Work In Progress) という文字列を付与して作業していました。 実際の PR は下記の URL です。

github.com

ファイル変更が 160 と多いですが、ほぼほぼリネームです。 主要な変更点は /guide/ 以下にドキュメントを追加する作業でした。

無事マージ

PR を送ってから、slack の GROWI workspace 上で改善点を指摘してもらって、すぐにマージされました。

f:id:weseek:20191028182549p:plain

今後考えていること

まだ構想段階ですが、下記のような流れで情報をまとめていけたら、と考えています。(お手伝いいただける方募集中です)

  1. GROWI 本体から GROWI Docs (https://docs.growi.org) へのリンクを追加
  2. github にある weseek/growi の README.md に掲載されている情報、wiki を docs.growi.org にまとめていく
  3. growi.org も併せた情報の整備 (i18n 対応)
  4. 海外の方に知っていただきたいので、もっと発信は増やしていきたい

最後に

正直、独断と偏見でユーザーズガイドを用意したので、「読みにくい」とか「大して役に立たないのではないか」など不安はありますが、今まで機能を紹介する場所が無かったので、その場所を作ることができたことは個人的に満足しています。

多少なりとも GROWI を使ってくださっている方、これから GROWI を使おうとしている方に GROWI docs を一目でも見ていただけたら嬉しいです。

Slack の GROWI workspaceWESEEK の Twitter アカウント などでご意見、ご感想をお待ちしています。

蛇足

しれっと awesome-vuepress にも PR しておきました。

github.com