見出し画像

DITA XMLコンテンツ執筆で無からヒーローへFrom Zero to Hero in DITA XML Content Writing

From Zero to Hero in DITA XML Content Writing
DITA XMLコンテンツ執筆で無からヒーローへ


By Bénédicte Rivory
ベネディクト・リヴォリー

July 25th, 2023
2023年7月25日


Introduction
はじめに

DITA XML is a powerful standard for creating technical documentation. Whether you are managing product documentation, training content, quick-start guides, or tutorials, DITA XML can dramatically improve the quality of your documentation and deliver the best possible user experience.
DITA XML は、技術文書を作成するための強力な標準です。製品ドキュメント、トレーニングコンテンツ、クイックスタートガイド、チュートリアルのいずれを管理する場合でも、DITA XMLはドキュメントの品質を劇的に向上させ、可能な限り最高のユーザー体験を提供します。

However, learning how to create DITA XML content is a skill that has to be learned: delivering high-quality technical documentation has to be earned! Here are the key steps you need to follow to create DITA XML content like an expert.
しかし、DITA XMLコンテンツの作成方法を学ぶことは、高品質の技術文書を配信することを獲得する必要があるスキルです。ここでは、エキスパートのようにDITA XMLコンテンツを作成するために必要な主な手順を紹介します。

Get to grips with DITA XML environment
DITA XML環境を理解する

DITA XML is a complete and specific standard, tailored to the needs of users. So you need to start by understanding the basics!
DITA XML は、ユーザーのニーズに合わせて調整された、完全で具体的な標準です。ですから、まずは基本を理解することから始める必要があります。

This includes understanding the different types of DITA elements, how they are used, and how they are properly structured. There are many resources available to help you familiarize yourself with the DITA XML standard, including Learning DITA coursesDITA XML community, and a glossary of specific terms.
これには、さまざまなタイプのDITA要素、その使用方法、および適切な構造の理解が含まれます。DITA XML 標準の理解に役立つリソース は、DITA の学習コースDITA XML コミュニティー、特定の用語集など、多数用意されています。

Once you have a basic knowledge of the DITA XML standard, you can start learning how to apply it to your technical writing projects, and let the magic happen:
DITA XML標準の基本的な知識を身に付けたら、それを技術執筆プロジェクトに適用する方法を学び始め、魔法のような現象を起こすことができます。

  • Creating a DITA map
    DITAマップ作成

  • Creating topics
    トピック作成

  • Structuring your content
    コンテンツの構造化

  • Reviewing content
    コンテンツの見直し

  • Customizing your documentation
    ドキュメントの仕立て

  • Publishing to an output format
    出力フォーマットに出版

It’s essential to familiarize yourself with the standard before starting content writing. This will enable you to better understand the following steps, establish your workflow, and create well-structured documentation.
コンテンツの作成を開始する前に、標準に慣れることが不可欠です。これにより、次の手順をよりよく理解し、ワークフローを確立し、適切に構造化されたドキュメントを作成できます。

Arm yourself with the necessary tools for DITA XML
DITA XML に必要なツールを身に付ける

Once you have acquired a basic understanding of DITA XML, you’ll need to equip yourself with the tools you need to create and manage technical content! The most popular tools are:
DITA XMLの基本的な理解を習得したら、技術コンテンツの作成と管理に必要なツールを身に付ける必要があります。最も一般的なツールは次のとおりです。

Oxygen XML Editor: An ultra-powerful, highly versatile XML editor that supports DITA and provides good coverage of all XML technologies.
Oxygen XML エデイター: DITAをサポートし、すべてのXMLテクノロジーを十分にカバーする、非常に強力で汎用性の高いXMLエディターです。

DITA-OT (DITA Open Toolkit): A free, open-source toolkit that can be used to create, manage, and publish DITA XML content.
DITA-OT (DITA オープンツールキット): DITA XML コンテンツの作成、管理、公開に使用できる無料のオープンソースツールキットです。

ここから先は

8,029字 / 1ファイル

¥ 600

この記事が気に入ったらサポートをしてみませんか?