2

私は、DITA を使用して一般的なビジネス プロセス標準を作成しているテクニカル ライターです。私が DITA を選択したのは、トピックの組み立て、コンテンツ参照、および条件付きプロファイリングが優れているためです。これらはすべて、複雑で相互に関連するドキュメントを管理するのに役立ちます。

使用するトピック タイプを選択する必要があります。

3 つのオプションがあります。

  1. 自分の正確なニーズを満たす独自のトピック タイプを専門化できる
  2. トピックトピックを使用できます。
  3. OASIS コンピュータ ドキュメントのトピック (概念/タスク/リファレンス) の 1 つまたはすべてを使用できます。

オプション 1 は、DITA 開発者にアクセスできないため現実的ではありません。さらに、疑似コードであっても特殊化を設計することは簡単ではありません。

これにより、オプション 2 と 3 が現実的になります。

オプション 2 では、トピック トピックを使用しています。これは、最も寛容なトピック タイプであるため、柔軟性があります。また、他の目的のために設計されたトピック タイプを使用していないため、最も「クリーン」です。ただし、トピックトピックは実際には専門化のベースであり、直接使用することは想定されていません。

オプション 3 では、コンピューター ドキュメントのトピックを使用します。多かれ少なかれ、コンテンツを彼らに適合させることができます。ただし、実際には、特定の種類の方法で記述された「トリパン ヘルプ」タイプのコンテンツを対象としています。たとえば、これらのトピック タイプは、ジョン キャロルのミニマリズムに従って執筆する場合によく使用されます。このミニマリズムは、ユーザーの実験を奨励し、ユーザーのタスクに焦点を当てています。私の種類のドキュメントは要件を義務付けており、執筆においてミニマリストの原則を奨励したくありません。

オプション 2 と 3 の両方に妥協が伴います。プロセス標準を作成する場合、どちらが優れていますか?

4

6 に答える 6

5

もう 1 つのオプションは、DITA for Publishers プロジェクトによって提供されるトピック タイプを使用することです。これは、記事、章、サブセクション、サイドバー、およびパートなど、一般的な技術文書以外の出版コンポーネントをモデル化することを目的としています。

DITA for Publishers プロジェクトはhttp://dita4publishers.sourceforge.netにあります。

新しいトピック タイプを定義する必要があるのは、トピック タイプのタグ名を区別することだけであることに注意してください。

http://www.xiruss.org/tutorials/dita-specialization/にある構成と専門化のチュートリアルで手順を説明していますが、今見てみると、トピックの専門化のチュートリアルは単純な root を実行するだけではなく、実際にはもっと複雑であることがわかります。タグ名のみの特殊化。

于 2013-03-02T12:15:37.070 に答える
4

型の概念、タスク、および参照は、コンピューターのドキュメント専用ではありません。これらのタスクも次の目的で使用します

  • 教科書
  • ビールの自家醸造ガイド
  • 料理レシピ

これらすべての例で、コンテンツを標準の Dita 型に分割することが可能でした (常に簡単というわけではありません)。「コンピューターのドキュメントではない」という用語はあいまいすぎます。あなたの種類のコンテンツについて詳しく話すと、多くのditaの専門家がアドバイスできると思います.

于 2013-03-01T16:43:03.917 に答える
3

DITA は技術文書用の言語として開発されましたが、それはコンピューターの文書とは同じではないと思います。

Concept タイプを使用して、ユーザーが何かを理解するのに役立つ情報を提供します。これは、「なぜこの SOP に従う必要があるのか​​」のように単純な場合もあれば、難解なアルゴリズムがどのように機能するか (ユーザーがタスクを正しく実行するためにそれを理解する必要がある場合) を説明する場合もあります。

ユーザーがアクティビティを実行する方法を説明するときはいつでも、Task タイプを使用します。これは、「これをクリックしてください」と「それを入力してください」という手順の番号付きリストである必要はありません (ただし、これはソフトウェア ドキュメントでよく使用されるケースです)。必要に応じて、より自由な形式にすることができます (特に「一般的なタスク」タイプを使用する場合)。ここでの違いは、何らかの方向性を提供していることです。

Reference タイプを使用して、ユーザーが検索する必要がある情報を提供します (通常はアクティビティをサポートするため)。トピックが完全にリストまたはテーブルである場合、それはほぼ確実に参照情報です。

経験豊富なテクニカル コミュニケーターは、特定の状況でどのトピック タイプを使用するかについて意見が分かれる場合がありますが、これらは、これら 3 つの主要なトピック タイプを区別するための一般的なガイドラインです。

必要に応じて一般的なトピックを使用することもできますが、CTR (概念、タスク、参照) モデルを使用して情報を整理することは、テクニカル コミュニケーションにおける成功の実績が証明されており、たとえ情報が技術的な性質のものでなくても、ユーザーに役立つ可能性があります。たとえば、ビジネス プレゼンテーションを考えてみましょう。多くの場合、「whoozy ウィジェットとは」で始まり、「whoozy ウィジェットがあなたの人生をどのように変えるか」に続き、whoozy ウィジェットの購入または詳細情報の取得へのリンクで締めくくられます。クリック率。

于 2013-03-07T12:03:36.803 に答える
2

開発者にアクセスできない場合は、DITA Generatorを使用して、新しいルート要素のみを追加する単純な特殊化を生成できます。構造的特殊化を作成しない場合でも、カスタム シェル DTDを生成する必要があります。これにより、タスクなどの基本トピック タイプを使用できますが、プログラミングやソフトウェア ドメインなどを必要としない場合は含めません。

于 2013-03-03T10:23:23.017 に答える
1

このような多くのケースでは、オーサリング中に意味論的にタグ付けされたコンテンツがどれだけ厳密に望ましいかに基づいて DITA の利点を評価し、視聴者のニーズに応じてレンダリングが行われるようにする必要があります。特殊化は、より高いレベルのセマンティック タグ付けを実現する唯一の方法だと思います。たとえば、最初に「要件」という 1 つの専門的なトピックがあるとします。ただし、時間の経過とともに、ハード要件、ソフト要件、必須要件、規制要件、機能要件、非機能要件など、要件要素を他のタイプにさらに特化する必要が生じる場合があります。専門化のレベルを決定するのは、この専門化でタグ付けされたコンテンツを他のシステムで使用する必要があるかどうかであり、そうであれば、

誰かの試みを思いとどまらせるわけではありませんが、現実的に言えば、特定のドメイン向けの包括的な DITA 専門化を開発するには長い時間がかかります。半導体業界では、SIDSCと呼ばれる専門分野が 2007 年から開発されており、多くの企業や開発者が関与していますが、その複雑さのために業界全体でまだ広く使用されていません。しかし、当社の製品は複雑化する傾向にあるため、当社の情報開発者は、この専門分野を使用しているため、文書化や出版の課題にうまく対応できます。

于 2013-04-25T00:16:50.967 に答える
0

そして、あなたは概念を使用していません。なぜなら...？

私の経験では、お客様は多くの概念や一般的なトピックを使用していると簡単に言えます。これは実際、いくつかの業界で非常に一般的です。ドキュメントが説明 (タスク) でない場合は、概念を使用するだけで、何も専門化する必要はありません。

しかし、何らかの理由で非常に特別なものが必要な場合は、専門化を検討する必要があります。http://dita-generator-hrd.appspot.com/にアクセスして、それを可能にしてください。:)

于 2013-04-19T11:30:31.803 に答える