easyDITA Documentation

send feedback

❮ Previous Next ❯

Content Organization Strategies

Organizing files in your content library in a consistent way makes it easier to manage, find, and reuse content.

Content Library Overview

easyDITA enables you to browse, filter, create, upload, and manage files and folders in the content library.

User Guide

Content Library Structure

You can move and rename files and folders in the content library without breaking links between the resources. This means that your content library structure may freely scale.

Folder Structure

The following example shows a sample folder structure in the content library.

Library
- _Shared
  - DITAVALs
  - Warehouses
  - Variables
- Documentation
  - Internal
    - _Media
    - Courses
      - Onboarding_1
      - Onboarding_2
      - Onboarding_3
    - Guides
      - Content_Development_Style_Guide
    - Knowledge_Base
      - Product_A_Internal_Settings_Reference
      - Product_B_Hardware_Part_Numbers
  - External
    - _Media
    - Courses
      - Getting_Started_with_Product_A
      - Getting_Started_with_Product_B
      - Getting_Started_with_Product_C
      - Mastering_Product_C
    - FAQs
    - Glossaries
      - Product_A_Glossary
      - Product_B_Glossary
      - Product_C_Glossary
    - Guides
      - Product_A_User_Guide
      - Product_A_Reference_Guide
      - Product_B_User_Guide
      - Product_B_Technician_Guide
      - Product_C_User_Guide
      - Product_C_Admin_Guide
- Business
  - Company_Wide_Policies
  - Department_A
    - Policies
  - Department_B
    - Policies
    - Technical_Writing_Memes
  - Department_C
    - Policies
    - Procedures
- Sandbox
  - User A
  - User B
  - User C

Folder Role

The following list explains the role of folders that your content library may contain.

_Shared

Contains global reusable content, including: content warehouse topics, variable warehouse topics, and DITAVALs.

For more information, see Reuse Strategies and Conditional Processing Strategies.

Documentation

A container for internal and external documentation.

Internal

Contains the following:

Internal documentation and courses divided into subfolders
A _Media folder

External

Contains the following:

Customer-facing documentation and courses divided into subfolders
A _Media folder

_Media

Contains multimedia files like screenshots, GIFs, or diagrams.

Business

Contains internal business-related information divided into several subfolders that correspond to different departments.

Sandbox

A place where authors can freely test their ideas in relation with content development.

Content Organization Guidelines

Keep the following guidelines when creating a folder structure in the content library:

To display a folder at the top of the folder tree, add an underscore “_” before the folder name. For example: _Shared or _Media.
Depending on the architecture of content that you develop, you can create more _Shared folders on lower levels. For example, there may be a separate _Shared folder for documentation and business.
Depending on the architecture of content that you develop, you can keep _Media folders on higher or lower levels. Keeping _Media folders on low levels may hinder reuse.

There was a problem loading this topic