Creating courses and tutorials (Knowledge Transfer process)

This article describes the KT, how to develop a course, and upload videos. Learn how to start the Knowledge Transfer process, create the course assets, and upload a video to the Media Publishing Cloud (MPC).

What is a Knowledge Transfer (KT)?

When engineering starts a feature, the product manager creates a corresponding wiki (KT). The KT is where everyone shares knowledge about a product or feature. Engineering creates an associated task, which includes Epics and Stories that track progress.

KT Structure

Epics correspond to features. Stories correspond to the content (tasks) and deliverable types you author or create (video, article, course, and so on). All the wiki page watchers are notified when questions are raised or updates added to wiki.

Creating and uploading video

The video How to create and upload a video provides an example (using AEM Commerce) on this process.

  1. Create a Jira Story.

  2. Record the video:

    1. (Optional) create a script.
    2. If scripting, you can record the audio in Audition.
    3. You can record video with QuicktTime.
  3. Edit the video in Premiere Pro.

  4. Upload the video to Media Publishing Cloud (MPC), setting metadata fields and chapters when appropriate.

    See Uploading video (below) for steps.

    This step requires permission to upload videos to MPC. The MPC page provides a one-time prompt to request access from your manager.

  5. Create a thumbnail (for each asset) from the poster’s page.

    1. Save image from poster’s page.
    2. Open the image in Photoshop and save at 400 x 225.
    3. Upload the thumbnail to Sharepoint.
  6. Create a thumbnail for course (also used in CaaS).

  7. Create a Git branch if needed.

  8. Fetch the branch from Git in GitHub Desktop.

  9. Using VS Code, create the Markdown file with the proper metadata.

  10. Add the file to the repo’s TOC.

  11. Push the new or edited files to GitHub.

  12. Perform a Pull Request to the Main branch (if you used a different branch).

    You should get a message from sccm-bot in Slack, and you can view/check the files on experienceleague.corp.adobe.com via the link in Slack.

  13. Click Publish in Slack and initiate the publishing process in Jenkins.

    When this is done, it will be live in ExL.

  14. Fill in the final fields in Jira, including:

    • Set the Publish link to the public URL
    • Duration
    • Description
    • Create a link to the GitHub page
    • Create a link to the MPC video embed code
    • Mark the ticket as Done

Uploading Videos to Adobe TV (using MPC)

When creating videos for users, upload the videos to Adobe TV. Do not use YouTube, Vimeo, or another third-party platform.

The Technical Marketing team manages video content for Experience League. Before you create a video, that you have access to the proper location within Adobe Media Publishing Cloud (MPC) and that you avoid duplicating existing content.

  1. Create a KT Story in the KT project for each video.

    Here’s an example KT Story. Adding the KT Story prompts the Localization team to pick up the video and add subtitles and TTS.

    When storing a video for AEM in MPC it should go in a new folder in the Help & Support > Experience League bucket.

NOTE

There should be a 1:1 mapping of the folder to an English video. The folder name should be the exact same name as the video file.

  1. Navigate to Adobe Media Publishing Cloud

  2. Navigate to the folder where you want to add the video.

    This step requires permission to upload videos to MPC. The MPC page provides a one-time prompt to request access from your manager.

  3. Click the upload icon from the top-right corner.

    upload video 1

  4. Drag-and-drop the videos to the dialog box (or click to Browse to your local location of the video), then add the title and description to your video.

    upload video 2

  5. Once the upload is complete, click Get Code under Embed Codes to access the publish link.

    upload video 3

  6. Copy the link to the video from the Shareable Link, as shown below.

    upload video 4

  7. Once you have the link, you can share the link or add the specific video to your documentation with the following syntax:

>[!VIDEO](https://video.tv.adobe.com/v/28380)

If you have questions about uploading videos, contact Sean Schnoor or a member of his team.

Create a video tutorial guide in Markdown

After you have your video URL, and the repo is created, create files like your guide’s landing (overview.md), the TOC, and your first article for the video link.

Prerequisites

  1. Install VSC and GitHub Desktop.

  2. Clone the repo (see Git setup for basics on using git).

  3. Follow the steps for uploading the video to MPC to get your URL.

Create a tutorial TOC and home page (overview.md)

TOCs (or table of contents) are complicated. You may need a walk-through from Bob to get started. (See Working with TOC.md files to learn how they work.)

Things to know:

  • The overview.md file serves as the repo (guide’s) landing page, but this does not mean that your overview.md page must contain overview material (in fact, it probably shouldn’t).
  • There is no technical requirement that your landing page file name is overview.md. For consistency, you should use that name.
  • A repo can contain multiple TOC files, but the overview.md is not required for every TOC.

Name your overview.md page

In the TOC.md, the link text of the overview.md file should match the overview’s # H1 page name (except where length is an issue). If you write an overview, use Overview of <product or feature name>. If you must call out roles, use something like, Workfront tutorials for project managers.

Useful editorial resources:

Create a video page

To create a basic tutorial (video) page:

  1. In Visual Studio Code, create a page and save it as .md.

  2. Add the following article metadata to the page:

    • title
    • description

    Metadata can be complicated. Please talk reach out to Blake for help.

  3. Add your page heading (# H1) after the metadata.

  4. Write your introductory sentence or paragraph.

  5. Add the video link according to Markdown syntax.

    For example:

       >[!VIDEO](https://video.tv.adobe.com/v/334111?quality=12)
    

    Here’s an example tutorial page:

    Example Tutorial Markdown

    (The metadata in the preceding image is sample-only.)

  6. Save your file.

On this page