The wikis are now using the new authentication system.
If you did not migrate your account yet, visit https://idp-portal-info.suse.com/

Documentation Team

移動先: 案内, 検索
Doku-wichtl.png
Geeko 我々は悪名高い Doku-Wichtl である。 openSUSE/SUSE Linux のマニュアルを作成したり管理したりしている部隊である。様々な種類の情報を収集して、開発者の脳みそからできる限り多くの知識を吸い上げ、わかりやすいものにするために働いている。宇宙で最も残酷な動物はネジ回しを持った技術者と呼ばれることもあるが、それは間違いだ -- 最も残酷なのは我々 Doku-Wichtl である! ;)


マニュアルの閲覧

オンラインのマニュアルはそれぞれの openSUSE バージョンと共に配布されているほか、ダウンロードすることもできます。たとえば openSUSE 11.2 マニュアル HTML 版、および PDF 版は http://www.novell.com/documentation/opensuse112/ からダウンロードできますし、以前の openSUSE/SUSE Linux バージョン向けのマニュアルは http://www.novell.com/documentation/ から参照することができます。また、 openSUSE をインストール済みの環境下では、 HTML 版のマニュアルを テンプレート:Susedoc:filename (または KDE/GNOME デスクトップのヘルプセンター) から閲覧することができます。それぞれのマニュアルの冒頭には、 openSUSE でどのようなマニュアルが用意されているかを一覧にしています。インストールメディア上のどこにマニュアルがあるのかについて、詳しくはリリースノートをご確認ください。

我々がマニュアルを作成して発行する場合、それぞれオープンソースのツールを利用しています (唯一例外があります: RenderX 提供の商用 FO フォーマッタ XEP です): マニュアルは Novdoc DTD と呼ばれる DocBook (http://www.docbook.org をご覧ください) のサブセットを利用して記述しています。 XML のソースファイルは xmllint で検証を行なったあと xsltproc で処理し、 Norman Walsh 氏によるスタイルシートのカスタマイズ版を利用して XSL-FO 形式に変換しています。最終的な PDF ファイルは、 RenderX 提供の XEP で生成しています。

SUSE Linux 10.1 以降では、我々のマニュアルに関する XML ソースファイルもあわせて提供しています。インストールメディア内の opensuse-manual_(言語) パッケージ (または http://download.opensuse.org/source/distribution/11.2/repo/oss/suse/src/) などからご利用ください。 .src.rpm ファイルをインストールすると、いくつかの tar ボール (*tar.bz2) ファイル内にそれぞれのマニュアルのソースファイルが入っています。

susedoc パッケージ

我々がマニュアルを作成したり発行したりするために使用するドキュメンテーション環境についても我々で管理しています。 susedoc*.rpm パッケージ (http://developer.novell.com/wiki/index.php/Lfl/susedoc もご覧ください) としてご利用いただけるほか、 openSUSE ディストリビューションと共に配布されています。必要があればインストールしてお使いください (XEP の代用として FOP でも動作します) :) 。

また、最新の susedoc*.rpm バージョンは、 openSUSE ビルドサービス (それぞれ openSUSE_(バージョン)/noarch/ 以下にあります) からご利用ください。

Lizards 向けレッスン (Lessons For Lizards (LfL))

openSUSE ドキュメンテーションに何らかの貢献をしたい場合は、いくつかの方法を用意しています。 Lizards 向けレッスン (Lessons For Lizards (LfL)) は、 GNU フリードキュメンテーションライセンス (GFDL) の下で提供される、 openSUSE ディストリビューション向けの説明書スタイルの書籍プロジェクトです。書籍はそれぞれの openSUSE リリースの際に、内部作成のドキュメンテーションと同じ形態で配布されます。 Lizards 向けレッスンでは、内部作成のマニュアルよりもより詳しい分野や風変わりなトピックを扱っています。たとえば:

  • 実験的なソフトウエア
  • サードパーティのドライバ
  • 複雑なセットアップ方法 (ホームネットワーク向けのルータに仕立てる手順など)

詳しい情報 (クイックスタート, FAQ, 貢献方法等々) は http://developer.novell.com/wiki/index.php/Lessons_for_Lizards をご覧いただくか、 opensuse-doc メーリングリストにて受け付けております。

フィードバック

あれ?これでもまだあなたの知識を吸い上げさせてくれないのですか?下記のような方法でも SUSE Doku-Wichtl をサポートすることができますよ:

  • マニュアル内に間違いなどがありましたら、 バグ報告 を行なってください (バグ報告方法 をご覧ください) 。
  • http://www.novell.com/documentation/ にて我々が提供しているオンライン版マニュアルには、ユーザコメント機能があります。マニュアル内で何か問題などがあった場合は、それぞれの HTML ページにある Add Feedback (フィードバックの追加) を押して知らせてください。
  • opensuse-doc メーリングリストを購読し、どのようにしたら改善できるのかを教えてください。 susedoc ドキュメンテーションシステムに関するフィードバックでもかまいません。

または、単純にマニュアルを世界中の文学で最も感動的なものに仕立てることができるのかについて、教えていただければうれしいです ;)

メンバー

  • Juergen Weigert (not an educated Doc-Wichtl)
  • keichwa (Karl Eichwalder)
  • Thomas Schraitle
  • Jakub Friedl
  • Tanja Roth (People of openSUSE)
  • Fsundermeyer (Frank Sundermeyer)
  • Florian Nadge
  • Mike Bowling
  • Tomaz Bazant
  • Björn Geuken (見習い)

Ex チームのメンバー

  • Tom Rölz
  • jjaeger1 (Jana Jaeger)
  • azouhr (Berthold Gunreben)
  • Christian Schneemann (見習い)
  • Jan Löser (見習い)
  • Matthias Weckbecker (見習い)

参照