Comments
Description
Transcript
第1章 SGML マニュアルの制作
第1章 SGML マニュアルの制作 翻訳マニュアル制作の基本的な流れ この章では、SGML フォーマットの翻訳マニュアルを制作する場合の作業の流れを概 説します。作業環境によっては、別の手順をとったほうが効率がよい場合もありま す。各マニュアルの工程管理を担当する方は、さまざまな条件を考慮して、適切な計 画を立ててから制作を開始してください。SGML フォーマットのマニュアルを日本語 で書き下ろす場合にも参考にしてください。 制作の前に (社内作業) 各プロジェクトのドキュメントの制作計画を立てる際には、US 、マーケティング、 各マニュアルの担当者の意見を参考にして、制作するマニュアルの量と質を決定しま す。 各マニュアルの担当者は、プロジェクトリーダー、プランナー (それぞれ場合によっ ては担当者が兼ねる) からの指示に従って制作を開始します。制作開始後に発生した 問題点については、プロジェクトリーダーやプランナーと相談しながら解決してくだ さい。 確認事項 作業内容によっては、マニュアルの制作スケジュールに大きく影響します。制作を始 める前に次の項目について、プロジェクトリーダー、プランナー、エンジニアチーム などと協力して決定しておいてください。 1 ■ どのバージョンの英語マニュアルから翻訳を開始するか 90 % 完成版、100 % 完成版、またはその他のバージョンから翻訳するかを確認しま す。 ■ どのフォーマットで作成するか 通常は SGML、FrameMaker、または HTML フォーマットで作成しますが、その 他のフォーマットを使用する場合もあります。また、印刷版、AnswerBook1、 AnswerBook2、またはオンラインのどの形式でマニュアルを作成するかを確認しま す。 ■ 画面を日本語版に合わせて撮影し直すかどうか ドキュメントの納期とソフトウェアの最終画面の確定時期を考慮して、日本語版用 に画面の図を撮り直すかどうかを決めてください。 英文マニュアルの画面をそのまま使用する場合は、画面のボタン、メニュー、メッ セージなどの翻訳・表記方法も確認します。通常は、「<実際に表示される日本 語>(流用した画面上に表示されている英語)」のように表記します。 ■ 用語や表記方法などの翻訳の方針 詳細は、第 4 章「執筆と翻訳」を参照してください。 ■ 各マニュアルで他のマニュアル名を参照している箇所の翻訳・編集方針 表 1-1 を参考にしてプロジェクトごとに、他のマニュアル名を参照している箇所の 翻訳・編集方針を立てます。 表 1-1 他のマニュアル名を参照している箇所の翻訳・編集方針 参照されているマニュアルが 各マニュアルの販売時点で AnswerBook 化されている AnswerBook 化されていない 日本語化されている クロスリファレンスを挿入して日本 手入力で日本語化する 語化する 日本語化されていない ■ クロスリファレンスを挿入せずに、 クロスリファレンスを挿入せず 手入力で英語のまま残す に、手入力で英語のまま残す 日本語環境向けにマニュアルの内容または構成を一部変更するかどうか マニュアルの内容を日本語環境向けに一部追加・削除・変更するかをエンジニア チームなどと協力して決定します。 2 日本語マニュアルの制作 ･ 1999 年 11 月 ■ 技術チェックの箇所、レベル、期間、担当者 エンジニアチームなどと協力して決定します。技術チェックの詳細は、18 ページ の「技術チェックを行う」の項を参照してください。 ■ 索引の付け方 不都合が生じない限り、英文マニュアルの索引に合わせて日本語マニュアルの索引 を作成します。英文の索引挿入箇所を参照して、編集担当者に索引の作成を指示し てください。なお、索引は、専門用語の訳が確定した段階で編集すると、修正する 手間が省けます。 ■ 旧版からの引き継ぎ事項 改版マニュアルの場合は、 /import/near/tech/sunsoft.user/manual/manual.notes/<プロジェクト 名>/ の下に、マニュアルごとに作業上の注意点、バグ、次回への要望などが記述 してあることがあります。必要に応じて参考にしてください。 ■ 日本語 Solaris 製品の構成 担当するマニュアルがどの製品に含まれるのか確認します。 ■ プロジェクト情報 /import/near/tech/sunsoft.user/projects/<プロジェクト名>/ の下に、 プロジェクトの関連情報を蓄積しています。必要に応じて参照してください。 その他のマニュアルの品質と作業工程に影響すると思われる個々の問題については、 各担当者が、プロジェクトリーダーやプランナーと相談しながら作業を進めてくださ い。 カードなど多色刷りのドキュメント 多色刷りのドキュメントなどでは、制作工程が通常のマニュアルとは異なります。リ リースコーディネータ (RC) チームからの情報を元に制作工程を検討して、通常のマ ニュアルよりも余裕のあるスケジュールを立ててください。なお、色自体に関する工 程は、RC チームの指示に沿って作業を進めます。 第1章 SGML マニュアルの制作 3 作業の流れ SGML フォーマットで AnswerBook2 形式および印刷版の翻訳マニュアルを制作する 場合の基本的な作業の流れを 5 ページの図 1-1 に示します。作業の流れの図には、一 部のマニュアルでは省略可能な作業も含まれています。作成するマニュアルの種類に 合わせて利用してください。各工程の詳しい作業内容については、7 ページの 「SGML マニュアルの制作工程」の節で説明します。 4 日本語マニュアルの制作 ･ 1999 年 11 月 SGML マニュアルの場合 日本語 Solaris 用のマニュアルを決定 マニュアルを登録 (Pubstool2 使用 ) ( タイトル、製品番号、AB2 の構成など ) ( タイトル、製品番号など ) 英文マニュアルを入手 旧版マニュアルとの差分をチェック 翻訳・編集 (Adept 使用 ) 技術チェックおよび校正 品質検査 AnswerBook2 を作成 (mkbook、Pubstool2、Netscape を使用 ) ( 英文 SGML ドキュメントのチェックリストなど ) * 改版マニュアルの場合 (gword、 『日本語マニュアルの制作 (Solaris 版 ) 』など ) ( 技術チェックリクエストなど ) (RC handoff チェックリストなど ) (mkbook プロセスチェックリストなど ) : 通常の流れ ( ) : 必要な資料 : ミスが発見された場合の流れ * 省略可能な手順 図 1-1 SGML マニュアル制作の流れ 第1章 SGML マニュアルの制作 5 印刷 (Adept Publisher 使用 ) * 印刷版を作成する場合 (RC hand-off チェックリストなど ) RC チームに hand-off 引継ぎ事項などをまとめる * 印刷版を作成する場合 (RC hand-off チェックリストなど ) (manual.notes など ) : 通常の流れ ( ) : 必要な資料 : ミスが発見された場合の流れ * 省略可能な手順 図 1-1 SGML マニュアル制作の流れ (続き) 注 – Solaris 2.6 から、マニュアルは基本的に SGML フォーマットで作成し、 AnswerBook2 形式、または AnswerBook2 形式および印刷版として提供してい ます。5 ページの図 1-1 には、FrameMaker フォーマットから SGML フォーマッ トへの変換作業は含まれていません。変換作業の詳細は、『日本語マニュアルの SGML への変換 (Solaris 版)』を参照してください。 6 日本語マニュアルの制作 ･ 1999 年 11 月 SGML マニュアルの制作工程 この節では、5 ページの図 1-1 での工程分けに従って、SGML フォーマットの英文マ ニュアルを元に SGML フォーマットの日本語マニュアルを作成する際の、各工程での 作業内容を説明します。この内容を参考にして効率のよい作業方法を検討してくださ い。サン・マイクロ (JLC) の担当者は、マニュアルの制作方法を検討して、協力会社 に発注する工程や内容を決定してください。 協力会社で作業する場合に解決できない疑問点が生じたときには、付録 C「ワーク シート」の「日本語マニュアルに関する質問票」をご利用ください。 注 – 各工程終了後に残るミスは、成果物の品質に大きく影響します。各作業には、作 業担当者とは別に作業結果をチェックする人を設定し、ミスを排除してくださ い。 日本語 Solaris 用のマニュアルを決定する (社内作業) 次の 3 つの作業を行います。 1. 翻訳対象となる英文マニュアルに関する情報を入手し、日本語マニュアルのタイト ルと、AnswerBook2 コレクションに含まれる日本語マニュアルを決定します。 注 – AnswerBook2 コレクションは、1 冊以上の AnswerBook2 形式のマニュアルで 構成されています。 マニュアル名および AnswerBook2 コレクションの構成を決定する際に必要な資料 は、次のとおりです。 ■ 翻訳の対象となる英文マニュアル関連情報 ■ マニュアル名の命名規則や過去のマニュアル名の例などを含む /import/near/tech/sunsoft.user/manual/title/ の内容 ■ ドキュメントプラン /usr/eng/projects/<プロジェクト名>/doc/ または /import/near/tech/sunsoft.user/projects/<プロジェクト名>/ の内 容 第1章 SGML マニュアルの制作 7 2. リリースコーディネータ (RC) チーム、プロジェクトリーダー、プランナーなどと 協力して、各本の製品番号 (Part Number) を取得します。リリース月とリビジョン (Revision) 番号も校正作業までに決定します。 3. プロジェクトごとに /import/near/tech/sunsoft.user/manual/title/ の 下に、日本語マニュアル名および製品番号と、AnswerBook2 コレクションに含ま れるマニュアル名および製品番号をリストしたファイルを作成し、RC チームや協 力会社などの関係者に連絡します。 このディレクトリには、他のプロジェクトのマニュアル名一覧のファイルもあります ので参考にしてください。 注意 – その後の工程でマニュアルのタイトルや製品番号などを変更した場合は、必ず その時点で上記のマニュアル名リストのファイルを修正して、変更内容を関係 者に連絡してください。 注 – 共有ディレクトリにファイルを作成するときは、グループとその他のユーザーに 対しても読み取り権と書き込み権を付けてください。ディレクトリやプログラム の場合は、グループとその他のユーザーに対して実行権を付けてください。手順 については、chmod(1) のマニュアルページを参照してください。 日本語 Solaris 用のマニュアルをデータベースに登録する (社内作業) 注意 – 登録作業はプロジェクトリーダーまたはプランナーが行います。 マニュアル作成中に、マニュアルのタイトルや製品番号などを変更した場合 は、必ずその時点で登録データを修正してください。 次の操作で Pubstool2 プログラムを起動して、日本語マニュアルの情報をデータベー スに登録 (register) します。Pubstool2 プログラムの使い方の詳細は、『Pubstool2 User’s Guide』を参照してください。 system% pubstool2 & 8 日本語マニュアルの制作 ･ 1999 年 11 月 /import/near/tech/sunsoft.user/manual/title/ の下にあるプロジェクト ごとのマニュアル名と製品番号一覧のファイルを参照しながら、Pubstool2 プログラ ムを使って、次のデータを登録します。 ■ 日本語マニュアルの場合 ■ 製品番号 ■ タイトル 登録の際に、マニュアルごとに本の略称 (shortname) が割り振られます。 ■ AnswerBook2 コレクションの場合 注 – 必ず日本語マニュアルとして登録してから、AnswerBook2 コレクションに含ま れるマニュアルとして登録してください。 ■ タイトル ■ 含まれるパッケージ名 ■ インストール場所 ■ AnswerBook2 コレクションに含まれるマニュアルの製品番号 ■ AnswerBook2 コレクションに含まれるマニュアルのタイトル 登録の際に、各 AnswerBook2 コレクションに Release 番号と Issue 番号が自動的に割 り振られます。AnswerBook2 コレクションのバージョンを更新するたびに、Issue 番 号は 1 つずつ大きくなります。 英文マニュアルを入手する (社内作業) 次の 2 つの作業を行います。 1. 翻訳対象となる英文マニュアルを随時入手して、 /import/near/tech/src/English/ の下の該当するディレクトリに置きます。 該当するディレクトリが存在しない場合は、関係者に連絡してからディレクトリを作 成します。 PubsTool2 を使ってデータを入手する方法については、付録 E「作業手順」を参照し てください。 第1章 SGML マニュアルの制作 9 注意 – Beta と FCS 段階の資料、あるいは First Delivery と Final Delivery の資料が共 存する場合は、後工程での混乱を避けるため、 /import/near/tech/src/English/ の下に<プロジェクト名>/<本の shortname>/<Beta または FCS> あるいは <FirstDel または FinalDel>/ のよう にディレクトリを作成してください。 2. 手順 1 で作成したディレクトリの下の Meta ディレクトリに、「deliver された英文 SGML ドキュメントのチェックリスト」のテンプレートを checklist ファイルとし てコピーします。 テンプレートは、 /import/near/tech/sunsoft.user/manual/checklist/SGML/ の下にありま す。 3. checklist ファイルを使って、入手した英文マニュアルを確認します。 英文ドキュメントに問題がある場合は、下記のリストを参照して既知の bug である か、または workaround があるかを確認します。 既知のバグリスト http://yakitori.Japan/html/SHIGOTO/PROJECT/FOSI/FOSI_BUG.html トラブルシューティング情報 http://ministop/private/data/Solaris/DOC/998/SGML/troubleshootin g.html 上記のリストに該当するものがない場合は、Bugtraq を使って bug として登録しま す。Bugtraq の使い方については、/tech/sunsoft.user/skill/ の下を参照して ください。 英文チェック作業の成果物 ■ チェック済みの新版英文マニュアルのファイルと紙出力 /import/near/tech/src/English/ の下の該当ディレクトリにあります。 ■ 記入済みの「deliver された英文 SGML ドキュメントのチェックリスト」 /import/near/tech/src/English/ の下の該当ディレクトリに checklist として置きます。 10 日本語マニュアルの制作 ･ 1999 年 11 月 旧版マニュアルとの差分をチェックする 英文マニュアルが改版マニュアルの場合は、旧版と新版を比較して、新版の紙出力上 で追加・削除・変更箇所にそれぞれ印を付けます。 旧版と新版のどちらのマニュアルも SGML フォーマットの場合は、Adept を使って差 分をチェックできます。詳しくは、付録 E「作業手順」を参照してください。 差文チェック作業で必要な資料 (社外の場合は貸し出し資料) ■ 英文マニュアル (旧版と新版) サン・マイクロ (JLC) では、/import/near/tech/src/English/ の下の該 当ディレクトリにあります。 差文チェック作業の成果物 (社外の場合は納品物) ■ 差文チェック済みの新版英文マニュアル (紙出力)、または変更箇所のタグが付い た新版英文マニュアルのファイル 翻訳・編集する 翻訳・編集工程は、翻訳・リライトと編集の 2 つの作業に分けられます。編集工程に は、索引の作成作業が含まれます。 翻訳・リライトする サン・マイクロ (JLC) 用の専門用語辞書 gword、『日本語マニュアルの制作 (Solaris 版)』(このマニュアル)、マニュアル名一覧、Solaris の製品構成、第 4 章「執筆と翻 訳」などを参考にしながら、各マニュアルの翻訳を仕上げてください。 通常、「翻訳」とは、英文の流れに沿っていて技術的には正確な直訳調の翻訳のこと を指します。一方「リライト」とは、日本語向けに表現を読みやすく変えるなどの翻 訳のブラッシュアップ作業のことを意味します。社外で翻訳する場合、リライト作業 を含めるかどうかによって作業内容や工程が大幅に変わることがありますので、サ ン・マイクロ (JLC) の担当者は留意してください。 第1章 SGML マニュアルの制作 11 編集する 13 ページの「翻訳・編集作業での確認項目」の項などを参考にして、SGML フォー マットの日本語マニュアルとして使用するときに不都合が生じないように、各マニュ アルを編集してください。編集作業は Adept 上で行います。SGML フォーマットや Adept の使い方の詳細は、『SGML ライターガイド』と『SGML ライターガイド (追 補): Adept の使い方』を参照してください。 社外で印刷版のマニュアルを作成する場合は、この工程で FrameMaker を利用して pagination ファイルを作成します。pagination ファイルの作成方法については、23 ページの「pagination ファイルを作成する」の節を参照してください。 版権ページを翻訳・編集する (社内作業) サン・マイクロ (JLC) の担当者は、Adept 上で日本語版版権ページ (legal.sgm) を更 新します。版権ページの更新方法については、付録 E「作業手順」を参照してくださ い。 英文マニュアルの版権ページが変更されている場合は、 /import/near/tech/sunsoft.user/manual/credits/ の下にあるプロジェク トごとの翻訳結果のファイルを参照して、必要に応じて法務部に確認し変更します。 修正内容がわからない場合は、プロジェクトリーダーに確認してください。 「はじめに」を翻訳・編集する サン・マイクロ (JLC) の担当者は、「はじめに」のテンプレート (preface.sgm) に必要な修正を加えて利用します。わかりやすい日本語マニュアルになるように各自 で工夫してください。 preface.sgm テンプレートは、 /import/near/tech/SGML_Template/SunLook_book/ の下にあります。必ず最 新のファイルを使用してください。 索引を作成する 編集工程で索引を作成します。不都合が生じない限り、英文マニュアルの索引に合わ せて日本語マニュアルの索引を作成します。索引は、専門用語の訳が確定した段階で 編集すると、修正する手間が省けます。社外で作業する場合は、サン・マイクロ (JLC) の担当者に索引の作成方法について確認してください。 12 日本語マニュアルの制作 ･ 1999 年 11 月 索引の読みがなは、読みがなツールを使って入力します。読みがなツールを実行後に 読みがなを確認して、必要に応じて修正してください。読みがなツールの使い方につ いては、付録 E「作業手順」を参照してください。 翻訳・編集作業での確認項目 社外で作業をしていて、翻訳・編集の方法または結果が不明な場合は、サン・マイク ロ (JLC) の担当者に確認してください。 注 – 第 4 章「執筆と翻訳」も参照してください。 ■ 原文のまま残すべき部分と訳すべき部分が正しく翻訳されていること 単なる訳抜けの確認ではなく専門知識に基づいて確認します。 ■ 原文の意味が正しく訳出されていること 次のような項目を念頭に置いて確認してください。 ■ ■ 原文の意味が逆に解釈されていないこと ■ ニュアンスや内容が誤って解釈されていないこと ■ 内容に抜けがないこと 論理が矛盾している部分、複数の意味に解釈できる文章、意味不明な文章がないこ と 英文自体に問題がある場合は、その旨を指摘してエンジニアチームに技術チェック を依頼してください。 ■ 専門用語が適切に統一されていること 英文での表現方法が異なっていても、実体が同じものは適宜、同じ専門用語に統一 してください。ただし、何らかの意味があって表現方法を変えてある場合は例外と します。特に、英文マニュアルの画面をそのまま使用する場合は、画面のボタン、 メニュー、メッセージなどの表記方法も確認します。 ■ 簡潔・明確な表現に統一されていること ■ コマンド、メッセージ、ファイル名などの英数字に誤りや抜けがないこと ■ 単位・記号が適切に統一されていること ■ 技術的な疑問が解決されていること 第1章 SGML マニュアルの制作 13 ■ 対象読者にわかりやすい表現になっていること 日本語環境が考慮されていること、一読しただけで意味がわかること、文体が適切 であること、漢字・カタカナ・英文が多すぎないことなどを念頭に置いて確認して ください。 ■ 用字・用語・送りがなが適切に統一されていること ■ 誤字・脱字・余字がないこと ■ マニュアル内の参照箇所が正しいこと 次の場合には、クロスリファレンスを挿入して、参照先と参照元の表現を統一して ください。 ■ 同じマニュアルの中を参照している箇所 ■ 他のマニュアルの名前を参照している箇所 プロジェクトごとの方針 (2 ページの表 1-1 を参照) に従って、正しく日本語また は英語になっていること ■ 法規、安全規格、品質保証などの関連事項が正しく記述されていること ■ 索引の用語・よみがなが正しいこと 編集手順については、12 ページの「索引を作成する」の項を参照してください。 ■ 商標マークなどの表記が正しいこと マニュアル内で最初に商標を使用している箇所に、次のように商標マークを付けま す。 ではなく を付ける ■ Sun の製品については、すべて ■ Sun 以外の製品については、Tmark ツールで検索されたものだけ付ける。 Tmark ツールの起動方法については、付録 E「作業手順」を参照してくださ い。 ■ Abstract.sgm または abstract.sgm ファイルに本の要約が記載されていること ■ 版権ページ (legal.sgm) の内容が正しく編集されていること 特に次の 3 つの項目を念頭において確認してください。 ■ ■ 追加・変更箇所が正しく編集されていること ■ 「[ その他 Sun の製品で商標が必要なもの ] 」の欄が残っていないこと ■ 原典の英文マニュアル名、製品番号、およびリビジョン番号が正しいこと 「はじめに」 (preface.sgm) の内容が正しく編集されていること 編集手順については、12 ページの「「はじめに」を翻訳・編集する」の項を参照 してください。 14 日本語マニュアルの制作 ･ 1999 年 11 月 ■ 図や表が正しく、抜けているものがないこと 画面を日本語版に合わせて撮影し直した場合は、英文マニュアルの画面と対応して いるか確認します。 社外で作業している場合は、サン・マイクロ (JLC) の担当者からの指示がない限り、 英文マニュアルの図を流用してください。 ■ /import/near/tech/sunsoft.user/manual/manual.notes/ に記載されて いるバグが直っていること (改版マニュアルの場合) ■ ディレクトリに不要なファイルがないこと ■ SGML ドキュメントとしてエラーがないこと 次の手順を実行してエラーメッセージが表示されないことを確認します。詳細は、 付録 E「作業手順」を参照してください。 ■ Adept 上でコンテキストチェック (Context Check) と完全性チェック (Completeness Check) を実行する。 ■ ■ ドキュメントのあるディレクトリで doclint.sgml を実行する。 PostScript ファイルを作成し、次の項目を確認します。 ■ 表紙、目次、索引、ページ番号などが正しく自動生成されていること ■ マニュアル名や住所が正しいこと ■ 表紙に最終的に決定されたマニュアル名、製品番号、リリース月、リビジョン番 号が次のように記載されていること x については、マニュアルごとに決められます。 Part No: xxx-xxxx-10 199x 年 xx 月 ■ 適切なフォントが使われていること ■ 次のような正しい情報がフッタに入っていること 偶数ページには、ページ番号 マニュアル名 ◆ 199x 年 xx 月 奇数ページには、章タイトル ページ番号 ただし、「パート」の全ページ、「はじめに」、「用語集」、「索引」の奇数ペー ジ、および各章の先頭ページにはページ番号しか表示されません。 第1章 SGML マニュアルの制作 15 ■ ページ番号が正しいこと 奇数ページでは右下、偶数ページでは左下に印刷されており、各章が偶数ページで 終わっている必要があります。ただし、マニュアルの最後が奇数ページで終わって いる場合は、偶数ページは追加されません。「用語集」と「索引」では、ページ番 号の左横に「用語集」または「索引」が付きます。 翻訳・編集作業で必要な資料 (社外の場合は貸し出し資料) 注 – 社外に資料を貸し出した場合は、 /import/near/tech/sunsoft.user/manual/vender/ の下の該当ディレ クトリに記載してください。 ■ 英文マニュアル (旧版と新版) サン・マイクロ (JLC) では、/import/near/tech/src/English/ の下の該 当ディレクトリにあります。 ■ 日本語マニュアル (旧版) サン・マイクロ (JLC) では、/import/near/tech/src/Japanese/ の下の該 当ディレクトリにあります。 ■ 関連マニュアル ■ gword サン・マイクロ (JLC) では、 /import/near/tech/sunsoft.user/dictionary/ の下の該当ファイルに 使用方法や登録方法などが記述されています。 ■ マニュアル名および製品番号一覧 サン・マイクロ (JLC) では、 /import/near/tech/sunsoft.user/manual/title/ の下にあります。 ■ 『日本語マニュアルの制作 (Solaris 版)』(このマニュアル) サン・マイクロ (JLC) では、 /import/near/tech/sunsoft.user/manual/rule/ の下にあります。 ■ 索引の作成指示 ■ その他ドキュメント関連資料 サン・マイクロ (JLC) では、ドキュメント制作に関する情報を /import/near/tech/sunsoft.user/ の下に蓄積しています。 16 日本語マニュアルの制作 ･ 1999 年 11 月 ■ pagination ファイルのテンプレート (社外で印刷版を作成する場合のみ) サン・マイクロ (JLC) では、 /import/near/tech/sunsoft.user/manual/checklist/ の下にありま す。pagination ファイルの作成方法については、23 ページの「pagination ファ イルを作成する」の項を参照してください。 ■ 「校正用チェックリスト」のテンプレート (社外で印刷版を作成する場合のみ) サン・マイクロ (JLC) では、 /import/near/tech/sunsoft.user/manual/checklist/ の下にありま す。 翻訳・編集作業の成果物 (社外の場合は納品物) ■ 新しく翻訳した専門用語の一覧 サン・マイクロ (JLC) の担当者は必要に応じて、その結果を gword に反映しま す。 ■ 日本語マニュアル (新版) サン・マイクロ (JLC) の担当者は、ドキュメントファイルを /import/near/tech/src/Japanese/ の下の該当ディレクトリに置きます。 該当するディレクトリが存在しない場合は、関係者に連絡してからディレクトリ を作成してください。 ■ pagination ファイル (Frame および PostScript ファイル) とその紙出力 (社外の み) 社外から、最終の印刷版の日本語マニュアルを納品するときに一緒に納品してく ださい。サン・マイクロ (JLC) の担当者は、ファイルを /import/near/tech/pubs/ の下の該当ディレクトリに置いてください。該 当するディレクトリが存在しない場合は、関係者に連絡してからディレクトリを 作成してください。 サン・マイクロ (JLC) では、23 ページの「印刷する (社内作業)」で作成しま す。 ■ 記入済み「校正用チェックリスト」(社外のみ) 社外の作業者は、checksheet という名前のファイルにして、最終の印刷版の 日本語マニュアルを納品するときに一緒に納品してください。サン・マイクロ (JLC) の担当者は、/import/near/tech/sunsoft.user/manual/vender/ の下の該当ディレクトリに置いてください。 第1章 SGML マニュアルの制作 17 社外から納品する場合は、 3.5 インチのフロッピーディスクまたは 1/4 インチのカー トリッジテープに入れてください。その他に必要となるものについては、担当者間で 相談してください。不要なファイルを納品しないでください。 技術チェックおよび校正を行う (社内作業) 技術チェックを行う マニュアルの種類やスケジュールを考慮の上、事前にエンジニアチームなどと協力し て決定した内容 (技術チェックの箇所、レベル、期間、担当者など) に従って進めま す。通常は、次のいずれかの箇所について技術チェックを行います。 ■ マニュアル全体 ■ 新規に追加・変更された箇所 ■ 新規に追加・変更された箇所と、英文自体に不明な点があるなどの技術チェックを かけた方がいいと思われる箇所 技術チェック後、必要に応じて編集作業に戻り、技術チェックの結果をドキュメント に反映してください。 技術チェック作業で必要な資料 ■ 英文マニュアル /import/near/tech/src/English/ の下の該当ディレクトリにあります。 ■ 日本語マニュアル /import/near/tech/src/Japanese/ の下の該当ディレクトリにあります。 ■ 「翻訳マニュアルの技術チェックのレベル分け」 /import/near/tech/sunsoft.user/manual/checklist/ の下の engcheck.level ファイルを参照してください。 ■ エンジニアチームへの技術チェックのリクエスト例 /import/near/tech/sunsoft.user/projects/<プロジェクト名>/ の下 の該当ファイルを参考にしてください。 技術チェック作業の成果物 ■ 技術チェック済みの日本語マニュアル サン・マイクロ (JLC) の担当者は、ドキュメントファイルを /import/near/tech/src/Japanese/ の下の該当ディレクトリに置きます。 18 日本語マニュアルの制作 ･ 1999 年 11 月 ■ 新しく翻訳した専門用語の一覧 必要に応じて、その結果を gword に反映します。 校正する 13 ページの「翻訳・編集作業での確認項目」の項を参考に、サン・マイクロ (JLC) の マニュアルとして不都合がないかどうかを確認します。問題がある場合は、付録 D 「校正記号一覧」を参考に修正してください。校正後、必要に応じて編集作業に戻 り、校正結果をドキュメントに反映します。 校正作業での確認項目 13 ページの「翻訳・編集作業での確認項目」および下記の項目を確認してください。 ■ Pubstool2 プログラムを使って登録したデータと、マニュアルに記載されている データが同じであること 異なる場合は、プロジェクトリーダーに連絡してください。 校正作業で必要な資料 ■ 技術チェック済みの日本語マニュアル /import/near/tech/src/Japanese/ の下の該当ディレクトリにあります。 ■ 英文マニュアル /import/near/tech/src/English/ の下の該当ディレクトリにあります。 ■ マニュアル名および製品番号一覧 /import/near/tech/sunsoft.user/manual/title/ の下にあります。必 ず最新の情報であることを確認してください。 ■ 製品番号、リリース月、リビジョン番号 /import/near/tech/sunsoft.user/projects/<プロジェクト名>/ の下 にあります。不明な場合は、プロジェクトリーダーに問い合わせてください。 ■ 『日本語マニュアルの制作 (Solaris 版)』(このマニュアル) /import/near/tech/sunsoft.user/manual/rule/ の下の該当ディレク トリにあります。 第1章 SGML マニュアルの制作 19 校正作業の成果物 ■ 校正済みのマニュアル (紙出力とドキュメントファイル) サン・マイクロ (JLC) の担当者は、ファイルを /import/near/tech/src/Japanese/ の下の該当ディレクトリに置きます。 マニュアルの品質を検査する 技術チェックと校正作業まで終了した日本語マニュアルの品質を検査します。品質検 査は、次の 2 種類に分けられます。 注 – インストール関連のマニュアルは、必ず品質検査を行なってください。 ■ マニュアルに記載されている手順に従って実際に作業を行い、マニュアルの記述に 問題がないかどうかを検査します。 プロジェクトリーダー、プランナー、エンジニアチームなどと協力して、品質を検 査するマニュアルと手順を決定します。 マニュアルに問題があった場合は、エンジニアチームなどに確認してから、必要に応 じて修正してください。 ■ 社外で、旧版マニュアルとの差文チェックから編集まで実施する場合、サン・マイ クロ (JLC) の担当者は、適切な段階で「マニュアル品質チェックリスト」を利用し てマニュアルの品質を検査し、検査結果を制作物に反映させます。 品質検査で必要な資料 (社外の場合は貸し出し資料) ■ ■ 技術チェックおよび校正作業済みの日本語マニュアル (紙出力) 「RC handoff チェックリスト (SGML 用)」のテンプレート (社内で作業する場 合) サン・マイクロ (JLC) では、 /import/near/tech/sunsoft.user/manual/checklist/SGML/ の下に あります。 ■ 「マニュアル品質チェックリスト」のテンプレート (社外で作業する場合) サン・マイクロ (JLC) では、 /import/near/tech/sunsoft.user/manual/checklist/SGML/ の下に あります。 20 日本語マニュアルの制作 ･ 1999 年 11 月 品質検査の成果物 (社外の場合は納品物) ■ 品質検査済みのマニュアル (紙出力とドキュメントファイル) サン・マイクロ (JLC) の担当者は、ファイルを /import/near/tech/src/Japanese/ の下の該当ディレクトリに置きます。 ■ 記入済み「RC handoff チェックリスト (SGML 用)」(社内で作業した場合) サン・マイクロ (JLC) の担当者は、ファイルを /import/near/tech/pubs/<プロジェクト名>/SGML/checksheet/ の下に 保管します。 ■ 記入済み「マニュアル品質チェックリスト」(社外で差文チェックから編集まで 実施した場合) サン・マイクロ (JLC) の担当者は、ファイルを /import/near/tech/sunsoft.user/manual/vender/<プロジェクト 名>/feedback/ の下に保管します。 AnswerBook2 を作成する (社内作業) 注 – AnswerBook2 (以降、AB2 とします) の Visual Inspection (VI) 中、場合によって はドキュメントを修正しなければならないことがあります。このため、印刷版の マニュアルを作成する場合、AB2 の VI 工程が終了する前に印刷工程を先に進め ると、オンラインマニュアルと印刷版マニュアルの内容に違いが生じることがあ ります。AB2 の VI が完了してから印刷工程へ受け渡す (hand-off) ことをお勧め します。 SGML フォーマットで作成した日本語マニュアルを元に、次の手順で AnswerBook2 形式のオンラインマニュアルを作成します。詳しい手順については、『SGML ライ ターガイド (追補): Adept の使い方』の付録 B「AnswerBook2 の作成」を参照してく ださい。 1. Pubstool2 を使ってドキュメントの SGML データを check out し、不要なファイルを できるかぎり削除します。 2. データを必要に応じて編集し、「mkbook プロセスチェックリスト (AB2 用)」を使っ て確認します。 /import/near/tech/sunsoft.user/manual/checklist/ の下に、「mkbook プロセスチェックリスト (AB2 用)」があります。このチェックリストは、手順 5 でも 使用します。 第1章 SGML マニュアルの制作 21 3. Pubstool2 を使って、データを check in してから submit します。 自動的に nightly build が実行され、AB2 のデータが作成されます。前日の 22 時まで に submit されたデータは、AB2 のデータとして翌日見ることができます。 4. Netscape を使って、VI を行います。 /import/near/tech/sunsoft.user/manual/checklist/SGML/ の下に、 「Visual Inspection 確認項目 (AB2)」があります。 問題がある場合は、手順 1 から 4 を再実行します。 5. 手順 2 で使用した「mkbook プロセスチェックリスト (AB2 用)」を使って、データを 確認します。 /import/near/tech/sunsoft.user/manual/checklist/ の下に、「mkbook プロセスチェックリスト (AB2 用)」があります。 6. 「2.7 AB2 マニュアルリスト」のステータスを更新します。 /import/near/tech/sunsoft.user/projects/998/SGML/ の下にある AB2.status ファイルの内容を確認して更新します。 このあと、オンラインマニュアル AnswerBook2 コレクションのパッケージが完成し ます。場合によっては、AnswerBook2 コレクション作成中にドキュメントの修正や追 加作業が必要になることがあります。その場合は指示に従ってください。 注 – AnswerBook2 コレクションは、1 冊以上の AnswerBook2 形式のオンラインマ ニュアルで構成されています。 AnswerBook2 作成作業で必要な資料 ■ 品質検査済みの日本語マニュアル (紙出力とドキュメントファイル) ファイルは、/import/near/tech/src/Japanese/ の下の該当ディレクトリ にあります。 ■ 「mkbook プロセスチェックリスト (AB2 用)」のテンプレート /import/near/tech/sunsoft.user/manual/checklist/SGML/ の下に あります。プロジェクトごとに必要な変更を加えて利用してください。 22 日本語マニュアルの制作 ･ 1999 年 11 月 AnswerBook2 作成作業の成果物 ■ 日本語マニュアルのドキュメントファイル ファイルは /import/near/tech/src/Japanese/ の下の該当ディレクトリ に置きます。 ■ 記入済み「mkbook プロセスチェックリスト (AB2 用)」 マニュアルの短縮名を付けて /import/near/tech/src/<プロジェクト名>/<カテゴリ>/<マニュアル短縮 名>/ の下に保存します。 印刷する (社内作業) 注 – この工程は、印刷版のマニュアルを作成する場合に実行します。 作業は次の 2 種類に分けられます。次の項で各作業工程について説明します。 ■ PostScript ファイルの作成と印刷 ■ pagination ファイルの作成 PostScript ファイルを作成して印刷する マニュアルの PostScript ファイルを Adept で作成して印刷し、「RC hand-off チェッ クリスト」を使って、印刷マニュアルとして問題がないかどうかを確認します。 PostScript ファイルの作成方法については、付録 E「作業手順」を参照してくださ い。 PostScript ファイルが正しく作成できている場合は、マニュアルの短縮名を付けて、 /import/near/tech/pubs/<プロジェクト名>/SGML/ps.file/ の下に保存しま す。記入済みの「RC hand-off チェックリスト」はマニュアルの短縮名を付けて、 /import/near/tech/pubs/<プロジェクト名>/SGML/checksheet/ の下に保存し ます。 pagination ファイルを作成する サン・マイクロ (JLC) では、この作業工程で pagination ファイルを作成します。 pagination ファイルは FrameMaker で作成し、PostScript ファイルとその紙出力を RC チームに提出します。pagination ファイルの作成方法については、付録 E「作業 手順」を参照してください。 第1章 SGML マニュアルの制作 23 pagination ファイルは paginate.doc と名前を付けて、 /import/near/tech/pubs/<プロジェクト名>/SGML/paginate.file/ の下に保 存します。paginate ファイルの PostScript ファイルは、マニュアルの短縮名.ps と名 前を付けて、/import/near/tech/pubs/<プロジェクト 名>/SGML/paginate.file/ の下に保存します。 印刷作業で必要な資料 ■ 品質検査済みの日本語マニュアル /import/near/tech/src/Japanese/ の下の該当ディレクトリにあります。 ■ 「RC hand-off チェックリスト (SGML 用)」のテンプレート /import/near/tech/sunsoft.user/manual/checklist/ の下にありま す。RC チームからの指示に従って、プロジェクトごとに必要な変更を加えて利 用してください。 ■ pagination ファイルのテンプレート /import/near/tech/NewLook/Solaris_Current_template/ の下の PaginateTemplate.doc にあります。 ■ PostScript ファイルの確認方法 /import/near/tech/sunsoft.user/skill/ の下を参照してください。 印刷作業の成果物 ■ 日本語マニュアル (紙出力、ドキュメントファイル、およびドキュメントファイ ルの PostScript ファイル) ドキュメントファイルは /import/near/tech/src/Japanese/ の下の該当 ディレクトリに、PostScript ファイルは /import/near/tech/pubs/<プロジェクト名>/ps.file/ の下に置きます。 ■ 記入済み「RC hand-off チェックリスト (SGML 用)」 マニュアルの短縮名を付けて /import/near/tech/pubs/<プロジェクト名>/SGML/checksheet/ の下に 保存します。 ■ pagination ファイル (paginate.doc と paginate.ps) /import/near/tech/pubs/<プロジェクト名>/paginate.file/ の下に保 存します。 24 日本語マニュアルの制作 ･ 1999 年 11 月 RC チームへ hand-off する(社内作業) 注 – この工程は、印刷版のマニュアルを作成する場合に実行します。 作業は次の 2 つに分かれます。 ■ 印刷工程への受け渡し (hand-off) ■ 青焼き校正 印刷工程へ hand-off する 次に、RC チームへの hand-off 作業の手順を説明します。 1. 「RC hand-off チェックリスト」に従って、必要なファイルを /import/near/tech/pubs/<プロジェクト名>/ の下の該当するディレクトリに置 きます。 適切なディレクトリが存在しない場合は、関係者に連絡してからディレクトリを作成 してください。 2. 「RC hand-off チェックリスト」の内容を確認後、RC チームにメールします。 3. RC チームから指示された印刷物を RC チームに手渡します。 hand-off 作業で必要な資料 ■ 記入済みの「RC handoff チェックリスト」 /import/near/tech/pubs/<プロジェクト名>/checksheet/ の下にありま す。 ■ 日本語マニュアル (紙出力、ドキュメントファイル、およびドキュメントファイ ルの PostScript ファイル) ドキュメントファイルは /import/near/tech/src/Japanese/ の下の該当 ディレクトリに、PostScript ファイルは /import/near/tech/pubs/<プロジェクト名>/ps.file/ の下にあります。 ■ pagination ファイル (paginate.doc と paginate.ps) /import/near/tech/pubs/<プロジェクト名>/paginate.file/ の下にあ ります。 第1章 SGML マニュアルの制作 25 hand-off 作業の成果物 プロジェクトにより異なる場合がありますが、通常は次のものを RC チームに渡しま す。 ■ 完成したマニュアルの紙出力 ■ pagination ファイルの紙出力 青焼き校正をする ● 印刷工程の途中で「青焼き原稿チェックリスト」に従って、青焼き校正を行います。 RC チームと協力して、すみやかに実行してください。 このあと、印刷会社の作業工程を経て、製本されたマニュアルが納品されます。 青焼き校正で必要な資料 ■ 青焼きされたマニュアル hand-off してから約 2∼3 週間後に、RC チームから渡されます。 ■ 「青焼き原稿チェックリスト」 /import/near/tech/sunsoft.user/manual/checklist/ の下にあります。 このチェックリストを参照しながら原稿を確認してください。RC チームに提出す る必要はありません。 青焼き校正の成果物 ■ 青焼き校正済みのマニュアル 制作の後に (社内作業) 翻訳マニュアルの作成後、必要に応じて次の作業を行います。 ■ JLC 内および US との postmortem 用のコメントをまとめ、プロジェクトリーダー に提出する /import/near/tech/sunsoft.user/projects/<プロジェクト名>/ の下に、 document チームの postmortem 向けコメントをまとめたファイルがありますので 参考にしてください。 26 日本語マニュアルの制作 ･ 1999 年 11 月 ■ 作成したマニュアルについてのメモを作成する /import/near/tech/sunsoft.user/manual/manual.notes/<プロジェクト 名>/ の下に、担当したマニュアルごとにファイルを作成し、作成上の注意点、バ グ、次回への要望などを記述します。 理想的な制作体制 日本語 Solaris マニュアル作成作業のうち、翻訳から編集までを協力会社で行う場合 に、理想的と思われる体制を示します。 第1章 SGML マニュアルの制作 27 サン・マイクロ (JLC) 側 各マニュアル担当者 発注全体の取り まとめ担当者 主な役割: 翻訳材料の入手・ 用意、質問・問題への対処、 品質検査、受け入れ作業 主な役割: 共 通事項への対 応 各担当者 各担当者 協力会社側 営業責任者 コーディネータ 主な役割: 翻訳から校正までの工程管理に責任を持 つ。各責任者と協力して、サン・マイクロ (JLC) との窓口として機能する 条件: サン・マイクロ (JLC) から、常に連絡がと れる状態にあること。コンピュータマニュアルの 翻訳制作工程に精通していること 各翻訳者 各担当者 各担当者 ・ ・ 主な役割: コーディネー タと協力して、必要とな る作業と連動させて費用 を見積る 編集責任者 主な役割: Adept による編集、校正の結 果の品質に責任を持つ 条件: SGML によるマニュアルの作成 に精通していること 翻訳責任者 各翻訳者 ・ ・ 主な役割: 翻訳結果の品質に責任を 持つ 条件: コンピュータマニュアルの翻訳と 翻訳対象技術に精通していること ＊ 各責任は、発注したマニュアルセット全体に対して生じる : 情報の主な流れ 図 1-2 28 理想的なマニュアルの制作体制 日本語マニュアルの制作 ･ 1999 年 11 月 : 発生する可能性がある情報の流れ 当資料は一部抜粋のサンプルです。 ご興味をお持ちになられた方、すべてをご覧になりたい方は、 以下よりお問い合わせください。 http://www.g-race.com/inquiry/index.html