IT Documentation [Template] | Scribe

    IT Documentation [Template]

    /DELETE AFTER READING: Here's a generic template that you can outline and share with Scribe.

    What is Scribe?

    Scribe is a free extension that generates how-to guides for any process— complete with text and annotated screenshots. Here's how to get started.

    Get started with Scribe today to duplicate and use this template. Here's how.

    Date: [X/X/20XX]

    Product Name: [Make sure to use consistent names across products and features.]

    Author:

    Approver:

    Version:

    Product Overview:

    Write out a brief description of the product or feature — be as clear and concise as possible.

    Objectives:

    What should the end result(s) be? Do you have any metrics or KPIs that you'll be tracking? List those goals here.

    • You are able to create a bulleted list, OR:

    1. You can also create a numbered list to sort priorities,

    2. This helps you measure objectives based on importance, or the timeline.

    Phases:

    Let's break your process out into phases or steps based on the project timeline.

    Phase 1: Planning

    Write a brief overview of this phase. Include:

    Team members:

    Start date:

    Deadline:

    ... and any other tracking info. Then, you can build Scribes to document each process. Click on the Scribe below to learn how to get started:

    How to create step-by-step guides with Scribe

    If this Phase includes several different processes, you can add a Scribe for each task. Here's a placeholder Scribe that you can replace with your own workflow.

    Click to replace with a ScribeClick to replace with a Scribe

    Phase 2: Execution & Launch

    Write a brief overview of this phase. Include:

    Team members:

    Start date:

    Deadline:

    ... and any other tracking info. Then, you can continue adding Scribes. Here's a placeholder to get you started.

    Click to replace with a Scribe

    Phase 3: Monitoring

    Write a brief overview of this phase and insert Scribes.

    Team members:

    Start date:

    Deadline:

    Click to replace with a Scribe

    Phase 4: Closure & Ongoing Follow-Up

    Write a brief overview of this phase and insert Scribes.

    Team members:

    Start date:

    Deadline: [if you have ongoing reviews, document how often and when you expect to follow up]

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