How-to Article [Template] | Scribe

    How-to Article [Template]

    [DELETE AFTER READING: Here is a generic template that you can use to build a how-to article with Scribe. You can learn more about Scribe here and see how to duplicate and use this template here.]

    This template is for creating a "how-to" article that guides readers through a specific task or function. It includes several sections to help organize the article and make it easy to follow.

    The template provides a structure for creating clear, easy-to-follow articles that help readers understand and complete specific tasks or functions.Title

    How to [Name of Function/Task — try to stick to a standard naming system]

    Introduction

    What is the article about? Is there additional detail you need to include? Add a video walkthrough if it would be helpful, like the one below.

    Task 1 <Name>

    Write a description (often brief) of the task/function to accomplish.

    Prerequisites (if applicable): a brief description of the problem (if needed)/features/tiers/customers to the task does or doesn't apply to.

    With Scribe Pages you have two options for how to create your visual instructions:

    1. Create a numbered list and insert images (see instructions above) Be clear and specific about each step.

    2. Use the Scribe extension to walk through your digital process and create a Scribe. Scribe will automatically document your steps, including annotated screenshots. Here's how:

    • Phase 1: <Name>

    Here is a placeholder Scribe that you can replace with your own workflow.

    Click to replace with a Scribe
    • Phase 2: <Name>

    Here is a placeholder Scribe that you can replace with your own workflow.

    Click to replace with a Scribe

    Task 2: <Name>

    Write a brief overview here.

    • Phase 1: <Name>

    Click to replace with a Scribe

    Outcome

    Write a brief description of the expected or realized solution.

    Conclusion

    A summary of what you've done and way forward. You can include a CTA here. 

    Further reading

    Links of three to six knowledge base articles with similar Information or processes.

    Click to replace with a Scribe
    This Page is in tip-top shape!Leave feedback if there are any issues with this Page