Structure of YDB documentation subject directories

Introduction

Documentation articles are arranged in a hierarchical structure of subject directories. A subject directory combines a set of articles on a certain general topic.

A topic description includes:

1. The target audience of the article. The audience depends on the role of a potential reader when working with YDB, with the following three basic audiences:
   • Developer of applications for YDB
   • YDB administrator
   • YDB developer/contributor
2. Purpose: The reader’s task or problem the solution of which is described in the content.

In general, the directory structure directly affects the structure of the documentation table of contents. Typical exceptions are:

• Intermediate stages of documentation creation. A new directory is created immediately to preserve the referential integrity in the future, but its content is still insufficient to be designed as a separate submenu in the table of contents. In this case, articles can be temporarily included in existing submenus.
• Historically established directories whose transfer is undesirable due to the loss of referential integrity.

Level 1 structure

The following subject directories are placed on level 1: