Structuring content

Target audience

Your target audience are the end-users which will consume the content you produce with ClickLearn. They are the ones whom you create content for. Your target audience is important to keep in mind when organizing your content. Content should always be organized in a way, which is intuitive for them to navigate and browse, and which makes it easy for them to find and consume the content they need.

Keeping recordings clean

One of the main benefits of recording with ClickLearn is the application will automatically capture screenshots and insert matching instructions. Authors always have the option to overwrite automatically captured instructional texts with their own manually created text. This should however be avoided whenever possible to ensure recordings can be easily updated, translated and/or tested through ClickLearn Replay. Content in a recording can be organized using one or more levels of sections, which can serve as headings in documents produced with ClickLearn. For example, if a document produced from a recording should begin with a paragraph named “Introduction”, with a couple of lines explaining what the recording is about, this can be achieved by inserting a section named “Introduction”, followed by a text block with the text paragraph. Using sections will help end-users navigate and consume the documentation.

Structuring topics

In technical communication, topic-based authoring is a modular approach to content creation where content is structured around topics that can be mixed and reused in different contexts. It is defined in contrast with book-oriented or narrative content, written in the linear structure, such as a book of fiction.

One or more recordings can be organized into one or more levels of sections, each section representing a logical topic. For example, if your documentation/training project contains several recordings within the topic of invoicing, you can create a section with that name and add the relevant recordings into the section.

Choosing and naming topics for your content should always be aligned with the end-user experience in the application you are documenting with ClickLearn Studio. Use terms and wordings end-users are familiar 10 with. For example, if an area in the application deals with invoicing, but end-users know it by a different internal company term, carefully consider which one to use in the documentation.

Below is a complete overview displaying all levels with which content can be organized in ClickLearn.

• Project
  • Section (one or more levels deep)
    • Recording
      • Section (one or more levels deep)
        • Recorded step, text block, etc.

Multiple projects & segmentation

Each project in ClickLearn Studio can be produced and deployed as one or more fully searchable websites, containing all other document and video formats produced with ClickLearn. As with recordings, there is no limitation to the number of projects which can be created, produced and published with ClickLearn. This adds the possibility of presenting role-specific content to select group of end-users.