Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

*** DRAFT ***

Creating topics/links to provide overview, procedures, and explanations of how the Doc team and Support will use Zendesk Guide to author help content in the edX Help Center. 

****************

The following steps detail the process of creating and updating documentation that is published to Zendesk Guide. The steps below contain links to pages with detailed information about how to perform that steps.

How content is organized in categories and sections


All Help Center knowledge base content is organized in the following tree structure:

Home > Categories > Sections > Articles

Each article must be a child of a section, and each section must be child of a category. You cannot have orphan articles or sections.

The Help Center must have at least one category. Today, the edX Help Center has one category, named FAQs. Categories are the top-level organizing containers of the Help Center. You can use categories as content portals for different products or services, or for different kinds of content. For example, you can create one category for partners and one category for learners. In the future, we've discussed creating categories for learners, course teams, and enterprise/integrations. 

If you have only one category in your Help Center (as we do today), then the category itself is hidden to end-users, and they see only the sections that are in your Help Center.

The new edX Help Center will have six main categories, containing a number of sections, which will correspond to current edX Learner Guide chapters. These sections will consist of as many articles as needed to cover the relevant content. 

Following the standard content structure:

Home > Categories > Sections > Articles

Home > Account Basics > (articles to support chapters)

Home > Payments & Refunds > (articles to support chapters)

Home > Courses > (articles to support chapters)

Home > Certificates > (articles to support chapters)

Home > Programs > (articles to support chapters)

Home > Credit > (articles to support chapters)

Additional Information

  • No labels