Layerpath Documentation

website·Indexed 34 days ago

https://docs.layerpath.com/

Guides for creating and editing interactive tours, guides, and video exports. Learn how to use the Agent for project creation, manage steps and layouts, utilize the Chrome extension for screen recording, and configure Brand memory to influence the creation process.

Tokens
8K
Snippets
1
Records
61
Agent score
57%

What's inside Layerpath

  1. Overview of Layerpath core concepts

    Layerpath converts software knowledge into reusable guidance for customer education, onboarding, and training. The system is built on a hierarchy where a single source of truth (the tour) powers multiple output formats.

    Core Model:

    • Workspace: The top-level container for projects, team folders, Playlists, Brand memory, and settings.
    • Project: The primary item created and organized in a workspace. Each project contains exactly one editable tour.
    • Tour: The editable source within a project consisting of ordered steps.
    • Step: An individual part of a tour. Available types include Intro, Image step, Video step, Blank step, and Outro.
    • Guide: A document-style presentation that mirrors the tour's steps for scanning or reading (can be copied as steps or downloaded as PDF).
    • Video export: A rendered, non-interactive version of the tour.
  2. Review and refine the generated Brand voice

    The Brand voice tab allows you to review what Layerpath learned about your company's writing style through two worked examples: Position your product (value communication for prospects) and Explain how it works (guidance for existing users).

    If the generated voice is incorrect, use the following process to refine it:

    1. Choose Needs changes on an example.
    2. Select a reason or describe the problem in your own words, then choose Review change.
    3. Review the proposed change and the rewritten samples. Note that a correction to one example rewrites both, as they stem from the same underlying voice.
    4. Choose Accept change to save the refinement, Refine to further adjust, or Cancel to discard.

    Note: Corrections only affect new projects after you explicitly choose Apply brand voice.

  3. Understand how Brand Memory affects project creation

    Brand Memory captures identity and wording guidelines to shape new projects. It is applied at the moment of creation and does not retroactively change existing projects.

    What it shapes based on creation path:

    • Create with Agent: Influences titles and body copy in the draft plan, callouts, step titles, connecting prose, and voiceover scripts.
    • Record your screen: Influences callouts, step titles, connecting prose, and the voiceover script generated after recording analysis.
    • Visuals: Both paths apply the active visual identity (colors, logos, and fonts).

    Key Constraints:

    • It does not rewrite existing projects or change previously generated voiceover audio files.
    • It provides guidance for generation but does not guarantee 100% adherence; manual review in the editor is required.
  4. Manually create Brand identity and voice

    Choose Create manually to upload identity assets and define workspace details yourself. This is the preferred method if you prefer not to share a website or if your website is unreachable.

    In the manual setup, you can:

    • Upload logos, colors, and fonts.
    • Define How you position your product to provide the value Layerpath should write about.
    • Add How you explain your product, tone characteristics, and preferred or avoided words.
    • Choose Generate brand voice to prepare results for review.
  5. Add and refine guidance in the editor

    Follow these steps to add and configure guidance (Hotspots, Areas, or Callouts) for a tour step:

    1. Select Target: Choose the step, open Insert, and select Hotspot. Place it on the target control or region.
    2. Set Type: Select the guidance, open the type menu, and switch between Hotspot, Area, or Callout as needed.
    3. Write Instructions: Use direct action verbs (e.g., "Choose Add member").
    4. Format: Use the contextual toolbar to adjust text formatting, add links, and change colors.
    5. Position Message: Set the position to Auto first. If the message obscures the target, manually select Top, Left, Right, or Bottom.
    6. Preview: Use the Preview mode to ensure the target is accurate and the message is visible on both desktop and mobile screens.
  6. Create a tour using the Agent

    The Create with Agent path allows you to generate an initial tour from existing materials rather than recording a live workflow.

    Supported Sources:

    • Images or video
    • Saved library media
    • Loom or YouTube links

    Process: Provide the source material and describe the goal for the viewers. The Agent prepares an initial tour, which can then be reviewed and refined in the editor.

    Limitation: This does not replace the "Record your screen" path used for capturing browser workflows.

  7. Initialize Brand memory in Layerpath

    Brand memory stores your company's identity (logo, colors, fonts, voice settings) and brand voice (words and tone). You can set this up using three different methods:

    1. Website URL: Enter a URL and choose Generate. Layerpath prepares the identity from the site, and after applying it, prepares Brand voice results for review.
    2. Upload PDF: Upload a style guide, design system, or brand-guidelines PDF (maximum size 25 MB).
    3. Create manually: Manually enter identity assets and provide brand-voice examples.

    To access these settings, open Brand memory in the workspace navigation. You must have edit permissions; viewer access is read-only.

  8. Verify Brand memory application in the editor

    Since Brand memory influences generated content, review the following elements in the editor before sharing a project to ensure they align with your brand:

    • Step titles and callout wording.
    • Adherence to preferred and avoided terms defined in Language rules.
    • Tone of the voiceover script.
    • Visual identity elements (colors, logo, and fonts) from the Brand identity tab.
    • General alignment of wording with the intended audience and purpose.
  9. Add an authored zoom to a tour step

    Use an authored zoom to create a specific focus region for a single step. This is distinct from the tour-level Auto zoom setting.

    1. Add the zoom to the desired step.
    2. Select the zoom and choose Preview Zoom to verify the framing.
    3. Delete the zoom if the wider context is more useful than the focused region.

    Note: Each step supports only one authored zoom.

  10. Review a recorded tour before sharing

    After recording a workflow with the Chrome extension, verify the following in the editor and preview to ensure the tour is accurate and safe to share:

    • Workspace & Access: Confirm the project is in the correct workspace and opens in the editor.
    • Sequence: Verify that the number and order of steps match the recorded path.
    • Visuals: Check that each step shows the expected page state and that hotspots/callouts point to the correct actions.
    • Content: Ensure the Intro, Outro, callouts, and voiceover are accurate.
    • Privacy: Confirm that no passwords, tokens, personal information, or unrelated browser content are visible.
    • Functionality: Test the complete tour in Preview mode.
  11. Create a project using existing media or links

    Use the Create with Agent workflow when you already have source material. You can provide the source via:

    • Upload from device: For new images or video files.
    • Choose from library: To reuse media already saved in your workspace.
    • Import Loom: By providing a Loom link.

    After adding the source, you must describe the intended viewer outcome (the task the project helps the viewer accomplish).

  12. Configure Brand Memory for identity and voice guidance

    Brand memory (Beta) is a workspace feature that guides the identity and wording Layerpath uses when preparing new projects.

    Setup Options:

    • Provide a website URL.
    • Upload a brand PDF.
    • Upload other brand assets.
    • Create guidance manually.

    Once configured, you can review the generated identity, wording, visual choices, and voice settings before sharing a project. Note that existing projects retain the Brand memory settings that were active at the time of their creation.