Jamz

現在、本サイトのデザイン・レイアウトを試行しているのですが、その作業を進める上でマークアップの見直しも実施しています。これまでの自身の成果を見返し、マークアップ・スタイルの改善・改良を目指しています。

一つの課題として、CSS の扱いを再検討するというのがあるのですが、これがなかなか大変な作業です。

以前、上ノ郷谷氏のエントリー (スタイルシートを書く時のガイドライン - 2xup) に触発されて以下のようなエントリーを書きましたが、ガイドラインとは別にドキュメンテーション (文書化) についても標準的なやり方がないか/作れないか模索しています。

• CSSガイドライン メモ編 (Jamz Design)
• CSSガイドライン 情報収集編 その1 (Jamz Design)

困った時の kanzaki.com と思い、神崎氏のサイトのソースを眺めていると何やら気になる記述があるではないですかっ！

/**
@prefix : <http://purl.org/net/ns/doas#> .
<http://www.kanzaki.com/parts/kan01.css> a :CSSstylesheet;
 :title "The Web KANZAKI standard stylesheet";
 :shortdesc "Common stylesheet for XHTML pages of this site";
 :created "1997-08-02";
 :release [:revision "3.34.1"; :created "2006-06-02"];
 :author [:name "KANZAKI, Masahide"; :homepage <http://www.kanzaki.com/> ];
 :license  .
*/

あまり見かけない namespace (名前空間) があるので URI (http://purl.org/net/ns/doas) を辿ってみると神崎氏のサイトにリダイレクトされます。

Ontology View: DOAS: Description of a Script/Stylesheet vocabulary

氏が提案している?名前空間のようです。

段々知識が追いつかなくなってきました。ここでいくつか気になること、疑問に思ったこと、分からなかったことをメモしておきます。

• purl.org に PURL Creation Form とかあるけど申請して取得できるんだ..
• Turtle/N3 という RDF の簡易記述形式 (Notation3：RDFの簡易表記から論理表現まで)
• 1つのスタイルシート = 1つのファイル何に記述するものらしい

コメントの書き方を提案している例があるなら、それらを JavaDoc や php documentor みたいに自動でドキュメント化してくれるツールもありそうだと思い検索してみると...

奇しくも宮永さんが数ヶ月前に投げかけたエントリーがヒット。

CSSDocを作りたい

コメントに定型フォーマットで情報をつけると、リファレンスHTMLを生成してくれるんですが、ふとこれのCSS版を作ったらどうかなぁと思いました。

CSSもコメントがC言語風(/* ～ */)ですからねぇ。 軽く探してみたところ見あたらなかったです。海外にも。

IburiTimes

私も探しましたが、やはり結果は同じでした。

Google の検査結果のページから Zope 系のサイトで cssdoc というキーワードがハイライトになっているのが気になりますが、リンク先はエラーが出て正常にアクセスできませんでした。(アレってエラー画面に表示されているキーワードなのかなぁ...細かく見なかったので...)

資料性の高い、視覚的に有効なドキュメンテーションは、長谷川さんが以前エントリーされていた C O U L D：Design In-Flight の CSS のマインドマップ化あたりかなぁ、という気もするのですが、実ファイルの更新とドキュメントの同期作業を考えると効率が悪いので本格的に取り組めずにいました。

そんな背景もあり、他に良い方法がないかなぁと色々と探しているわけですが...

やはり CSSDoc を作るしかないのかなぁ。作ったら世界的なヒーローになれますよ。ヒーローは大袈裟だとしても話題になることは間違いない。

一点、書き留めておこうと思うのは、CSS のドキュメンテーションはプログラム言語のそれとは異なり、出力されるドキュメントに視覚的要素がないと直感的に理解しづらいのではないだろうか？という懸念です。

実際の描画がドキュメント上で確認できると関係者全員で共有できる資料になりそうな気がします。制作者、運営者(クライアント)、更新代行業者、とかとか。

こういう未成熟な所を見るにつけ WEB 関連の作業 (プログラム開発とかマークアップ) は業務系のそれの １, ２年後発を進展しているように思います。フレームワークへの取り組みとか、ドキュメンテーションの捉え方とか特にそうだと思う。

さておき、本件は「継続的に取り組む必要がある課題だ」ということは分かったので取り敢えずこの辺りで... あぁ大変だ。でも楽しいなぁ。

追記

2006年12月25日 追記

こういう探究心が大事だなぁ、うんうん。

CSSのコメントの書き方コレアレ

他にどんな書き方があるのかなと気になりはじめたので、200サイトほど調べてみました。

3ping.org

2006年01月24日 追記

CSS を視覚化するサービス

CSS Poster

CSS をドキュメント化する方法はいくつかあるようですが、出力内容にはまだまだ問題があるみたい。

Yet Another Hackadelic - 新春CSSかくし芸大会の資料を公開します

CSS記述をスマートにするPHP （CSS Server-side Pre-processor） - youmos