Project structure

Learn how to structure your project to make localization easier.

Folder structure

A logical folder structure will make localization much easier. Don't keep all files in one folder. Instead, create separate folders for your topics, images, and other content.
Tip: To avoid publishing problems, always store your DITA maps at the same level as your topics and images or above them.

Prefixes vs. folders

It is common practice to prefix topic names with "c_", "t_", "r_," and "_g" for concepts, tasks, references, and glossary entries, respectively. For example:
  • c_magic_wand.dita
  • t_how_to_cast_a_spell.dita
  • r_wand_specifications.dita
  • g_wand_shaft.dita

For larger projects, it may be useful to create separate folders for topics of each type. This will make managing the project easier.

Figure 1. Example structure of a project with separate folders for different types of content
A flow chart depicting basic project structure with separe folders for images and different types of topics

Language versions

To simplify localization, create a separate subfolder for each language version. Each subfolder should have the same structure.

Figure 2. Example structure of a multilingual project with separate folders for different language versions
A flow chart depicting project structure divided into separe folders for different language versions

Files not to be translated

Some files, such as images and other content, are shared among language versions and don't need to be translated. It's a good idea to keep files you don't want to translate in a separate folder.

Figure 3. Example structure of a multilingual project with a separate folder for files you don't want to translate
A flow chart depicting project structure divided into separe folders for different language versions and a common folder for untranslated files