movabletype.jp
検索

ドキュメンテーションとタグリファレンスの今後

会議の模様

Movable Type の土台

Movable Type 6 がリリースされ早6ヶ月経とうとしています。セキュリティアップデートをはじめ、様々な調整や改善を続けていますが、製品を前進させるだけでは意味がないと考えています。土台をきちんと固めていなければ、いずれスピードを失うでしょうし、長期的な成長を遂げることは難しいでしょう。

Movable Type の土台とは一体なにでしょうか。Movable Type という製品の『土台』といえば、コアシステムやデザインを指しますが、それだけではありません。Movable Type の中にあるもうひとつの土台は、コミュニティです。長い方であれば、10 年以上使い続けている Movable Type 開発者の皆様の支えがあるからこそ、今も開発が続いているわけです(今でも私の席の隣で、開発部がソースコードと格闘しています)。

常に進化を続ける Movable Type ですが、それを使い続ける開発者に向けてのサポートには改善の余地があります。MTDDC のような大きなイベントから MTCafe のような小さな集まりを通して、製品に触れる機会は増えてきています。こうしたオフラインでの集まりだけでなく、オンラインで自分のペースで MT に触れる機会も増やさなければいけないと考えています。オンラインでの MT コンテンツの充実が、コミュニティへできる最低限のことでしょうし、その『土台』がきちんと出来て、はじめて次のステップへ進めるはずです。

今更だけど的確に確実に

オンラインコンテンツを充実させるための第一歩として、ドキュメンテーションタグリファレンスの再編成です。今でも最新版の情報は掲載されていますし、探せば必ず見つかります。しかし、幾つかの課題があります。

  • バージョンが羅列しているので、重複していたり管理が難しくなっている
  • 昔からのテンプレートを流用しているので、見せ方に限界がある
  • そのとき書いた人の文体が残っている場合がある
  • リリースを優先しているので、質が担保されていないものがある

より分かりやすく、調べやすい資料を提供するには、今の枠組みのままで設計するのは困難になりました。そこで現在、弊社サポートチームの協力を得て全ドキュメンテーションを見直しています。Movable Type 6 のドキュメンテーションを中心に品質チェックを行い、必要に応じて大幅な修正と加筆をしています。例えば、検索や長い文書をスキミングできるように、概要を加えるといった作業も行っています。

コンテンツシート

ドキュメンテーションが再整備されることで、初めての方(又は久しぶりに触る方)にとって分かりやすい文書を集めた『キュレーションページ』をつくったり、MT タグの理解が深まり、実践できるようなコンテンツと連携するといったことができるようになります。

現状維持のためのドキュメンテーションではなく、次のステップへ進めるためのドキュメンテーションを作っていることから時間がかかっています。しかし、今春にはβ版として開発者の皆様に見ていただけるようにしています(これと同時に英語版も動いていたりして)。

驚きの機能や、素敵な見た目を提供するのも良いことだと思いますが、まずは開発者の皆様が本当に欲しいもの(頼れる資料)を提供することが重要だと考えています。もうしばらくお待ちください。

デモ画面

シェアする

  • このエントリーをはてなブックマークに追加

トラックバック