暦にしらへん

最終改訂:

よろしくウカドック [伺か Advent Calendar 2014 -23日-]

関連・参考

UKADOCとは - はじめに

伺か関連の仕様文書集約プロジェクトであるUKADOC projectの編集するドキュメント集です。(UKADOCトップページより引用)

そして、現在主流のベースウェアであるSSPにとっての公式仕様文章でもあります。

まあ要は伺か関連コンテンツを作る時の事典のようなものだと思ってください。

この記事では、UKADOC Projectの一コミッタであるもっしょくしが好き勝手に、UKADOCが他の仕様まとめサイトと違ってどういう特色があるのか、なんだかdisc-2の「ゴースト制作」と似てるけど何が違うのか、そんな話をしていきます。

この記事を通じてもっとUKADOCが周知され、実態が解り、活用されると同時に意見や要望が気楽に飛んでくるようになればと思います。

あとはアドベントカレンダー2014で伺かまだあったのかと気付いた方がもし居られればと思って顔見せを……。

UKADOCのいいところ

簡潔にいうと情報が新しいの一言に尽きます。

言いたい事が終わってしまったのでもうこっから下の記事はオマケのようなものですがせっかく書いたので読んでいってくださいお願いします。

最新の機能や仕様がまとまっている

なんといってもこれ。

現状伺かにおいて標準的なベースウェアとなっているSSPは、今もなお盛んに更新が続けられており、古い資料ではその仕様を把握できません。

そのSSP最新仕様がまとまっているのは、同様に今も更新されているUKADOCだけ!

他の資料の誤りがだいぶ修正されている

ちょいネガティブな方向の長所。

UKADOCはdisc-2の「ゴースト制作」をベースにして発足しました。

なぜならそこが当時一番情報がまとまっていて、かつ比較的新しい場所だったからです。内容にとどまらずサイトデザインごと引き継いでいます(もちろん了承の上)。

ところがdisc-2(およびdisc-2が参考にしていたCROW・SSPリファレンスなど)には未だ修正されないままになっている誤記・記載漏れなどが結構あります。

そうした内容は当然UKADOCにも受け継がれていましたが、発見次第修正を重ねてきました。というよりも進行形で修正作業中です。

つまりSSPに関する新しい情報に限らず、場合によっては古くからある仕様についての記載も、他よりUKADOCの方が正確な場合があるということです。

具体例を二つだけ。

伺かの仕様として昔から存在してたが、disc-2に全く記載がなかった例。

最近修正されたばかりの例を一つ。シェルのアニメーション定義で、exclusiveオプションについての記載がわかりにくかった(おかしかった)のを改善。

両者を同じ意味に読める方はあまり居られない気がします。

時代に合わせたHowToの提示

上記2点と似たような話ではありますが。

UKADOCには、仕様文章というよりも、どちらかというとHowToにあたるような内容の記事も多少置かれています。

例えば配布用ファイルの作成のような、ゴースト等の製作にあたって必要になるごく基本的な作業の方法についての解説ページがいくつかあります。

こうした内容もdisc-2から受け継がれたものなのですが、問題はdisc-2に記事が書かれた当時と現在とでは、だいぶ状況が変わっているということです。

具体的には、新たなツールの出現であったり、機能の実装であったり、サイトの解説・移転・閉鎖だったりといった事が長い間にいくつもありました。

あるいは主流ベースウェアが本家伺か(MATERIA)からSSPへと変化した事も影響してきます(というよりUKADOCはSSPの公式仕様文章だという立場の違いもある)。

そのような環境の変化に伴って、一言でいえば古臭くなってしまった手法・手順というものも当然あります。

UKADOCは、disc-2の記事が書かれた当時よりも平易で新しい方法があるならば、積極的に記述を追加・修正し、今実際に活かせる記事にする事を念頭において編集しています(このようなHowToを仕様文章でどこまで扱うべきかについて、また別の葛藤もあったりするのですが……)。

例えばどんな具合かというと、特にピックアップして一つだけ。

是非disc-2の「初心者向け」カテゴリーの記事と、UKADOCの「HowTo」カテゴリーの記事を見比べてみてください。

最近のサイトの紹介およびリンク切れの削除、SSPの機能を利用したもっと便利な方法の紹介などを中心に、全体的により現状に即した内容に改めています。

多人数管理で長生きしやすい

従来のdisc-2やCROW・SSPリファレンスなどの他の資料と違って複数コミッタによる管理なので、誰かが都合が悪くなっても他がカバーできます。これは資料価値の劣化を引き伸ばすことに繋がるはずです。

先述の通り、UKADOCが参考にした他の資料においては、問題のある記載がなかなか修正されてこなかったという問題がありました。その原因の一つには、個人管理であるために、唯一の管理者の手が回らなくなってしまったら以後誰も手入れ出来ないという運営体制があるでしょう。

UKADOCは、いまは専ら自分が編集する機会が多いですが、例えもっしょくしが

>突然の死<

を迎えても、多分誰か気の向いた方がまたそのうち手入れを続けるはずです。少なくともその可能性は残ります。

現に自分も、UKADOC立ち上げ当初から編集をしていたわけでは全くなくて、以前中心的に編集されていた方の仕事を(勝手に)引き継いでいるのだったりします。

おまけ1:その他もうなんか色々ですよ

誤字修正、用語の統一、補足説明の追加、その他もう色々現在進行形でやっており、項目の列挙が中心だったdisc-2より幅広くいろんな情報が取り込まれてますのでdisc-2のゴースト制作が見慣れてるから……と言わず是非一度ざっと眺めるだけでもよろしくお願いします(必死)。

おまけ:HTML5で書かれていてちょっとは現代に生きてる感がある

「伺かまだあったのか…」に対して「あるわ貴様ちぎってなげるぞ」って言うための材料になるとかならないとかしなくていいとか。

課題と今後

もっと根本的な仕様をちゃんとまとめよう

現状トップページの「外部リンク」で他の資料を参照するように促していますが、UKADOCの究極目標は外部リンクにあるような仕様に関する情報を全部取り込む事ともいえるかもしれません。

後述の記述例の件もそうですが、disc-2のゴースト制作からそのまま引き継いでいる体質として、「既にある程度わかってる」人だけが活用できる情報というのが現状だと思います。しかしもっと窓口を広くする工夫をしてみたいと(一コミッタであるもっしょくしは勝手に)考えています。

例えば、どこまでやるべきかというのは悩みどころですが、ごくあたりまえに使っている「伺か」「ゴースト」「シェル」のような基本的な用語をきちんと説明するコーナーもあった方がいいかもしれません。

その他INSTALL規格とか……COMMUNICATE規格とか…… SHIORI/3.1制定……色々まとまってないので誰か助けてください。

記述例をもっと載せよう

各設定ファイルの記述例だとかは一応揃えたつもりでいます。

さくらスクリプトについても、協力を得つつ現在強化中です。CROW・SSPリファレンス並みには充実するはず。

それからサーフェスの描画メソッドについては図付きでまとめる予定があります。特にinsertとか……。

SSP以外のベースウェアについての記述がアヤシイ

UKADOCはSSPについては公式文章なので、SSPに関する記述については一定の責任を持ってまとめています。

が、裏を返せばそれ以外のベースウェアについてはあやふやな部分も多々……。

最近はMATERIAについては本家資料を一から読み直しながら多少は改善できている……はず。

しかしCROWについてはまぁ、なんというか、もしCROW・SSPリファレンスとUKADOCを比べて、CROWについて違う事が書いてあったら、多分CROWリファレンスが正しいですとだけ……。

頑張りたいのですが正直優先度はあまり高くないです。むしろ最近も更新が続いているninix-ayaや、アドベントカレンダーに記事も挙がっている現在開発真っ只中の「如何か」についてまとめたい気もしますね。誰かお願いします。

検索に引っかかりにくい

「ukadoc」で検索してもちっともドキュメントのトップページが出てきませんね(プロジェクトのトップは出るのですが)!

一応色々手は打っております。

まずプロジェクトページ(現状ukadocで検索して一番上に出る)からドキュメントのページへリンクも貼っていただきました。

それから、どうもgooglecodeによる変則的公開形態が検索性をかなり下げているらしいので、別サーバにファイル丸ごとのコピーを作成してそちらを公開用urlとするといった体制を整えていただきました。

最近はGoogleウェブマスターツールで色々やってみたりもしはじめました。

あとは公開用url(http://ssp.shillest.net/ukadoc/manual/)にブログやサイトの記事からリンクしまくってくださると、検索に引っかかりやすくなるので皆さんよろしくお願いします。

そのほか単純に解り難い・誤記・抜けがある等々

頑張って直しますので報告をください! 何卒お願いします。

連絡先はばぐとら研のTODOか、コミッタの誰か(もちろんもっしょくしでもOK)まで。

ちなみに…

ukadoc自体の公式なものではありませんが、一コミッタであるもっしょくしのukadoc編集についてのToDoはTrelloで管理しており誰でも見れます。進捗どうですかと聞かれたらパイ投げかエビフライの要領でこれをぶつけていきたいと思っています。

まとめ

  • UKADOCは伺か・SSPの仕様文書まとめプロジェクトである
  • UKADOCは新しく現代に生きナウでヤングでhtml5
  • まだまだ不足も誤りもたくさんあるけど現在進行形で改善中だしコミッタ制だから更新継続可能性も比較的大
  • google先生を振り向かせたいのでみなさんリンクしてやってください(http://ssp.shillest.net/ukadoc/manual/
  • 人手足りなさ過ぎるのでコミッタ募集してます