Skip to content

Make a template for guide creation #20

New issue
New issue
Closed
Closed
Make a template for guide creation#20
Labels
epicepic: templates for issue format

Description

@ExperimentsInHonesty
ExperimentsInHonesty
opened on Sep 13, 2021

Overview

We need to have a template for creating new guides on the Admin team so that we can speed up the process and bring on more team members.

Action Items

  • Review current method used during creation of 1Password guides and make a template from that
  • Make clear to make separate guides for processes and sub processes.
  • Decide what labels are needed and add them to the repo
  • Talk to Karen about it

Resources/Instructions

Epic for Workflow Modeling

Guide Template

Labels

Draft Guide
Create Guide
Needs Peer Review
Leadership Review
Ready for publication
Published
Published to admin only

New Issue Templates

Epic Workflow Modeling
Guide Template

Activity

  1. ExperimentsInHonesty commented on Sep 13, 2021

    @ExperimentsInHonesty
    ExperimentsInHonesty
    on Sep 13, 2021
    MemberAuthor

    Potential text for template for a single guide

    starting label: Status: Make Appt

    Dependency

    Creation of epic

    Action Items

    • Make appointment with member of admin team who is currently performing function.
      • remove label: "Status: Make Appt" add label: "Status: Record"
    • Link folder for recording and guide in defined sections below (see Resources).
      • Record workflow demo
        • remove label: "Status: Record" add label: "Status: Upload"
    • Upload recording and transcript.
      • link to folder, recording and transcript in the resources below
      • remove recording and transcripts from local or cloud storage
        • remove label: "Status: Upload" and add label: "Status: Create "As-Is"
    • Make a guide
      • Turn video transcript into step-by-step process confirmation
        • remove label: "Status: Create "As-Is" add label: "Status: Review "As-Is""
    • Admin reviews the "As-Is" adding missing steps or notes
      • remove label: "Status: Review "As-Is"" add label: "Status: Draft Guide"
    • Make a Guide using guide template
      • remove label: "Status: Draft Guide" and label: "Status: Review Guide"
    • Test guide with member of Admin team

    Resources

    • Admin team member currently performing function:

    How to make a guide

    Folders

    • Recordings & Transcripts
      • 📁Recordings general folder
      • 📁[INSERT NAME OF THE FOLDER Created during the Epic]
      • Link to specific recording and transcript (add links to the emojis)
        • ⏺️
        • ✏️
    • Guides
      • Guides general folder
      • 📁[Make folder link to the EPIC FOLDER]
      • 📁 [Make folder link to NAME OF THE FOLDER Created during the Epic]

    Legend

    📁 = Folder
    ✏️= Transcription
    ⏺️ = Recording
    📝 = "As-Is": Transcript edited down to steps (no pictures, no focus on writing instructions for others)
    👷‍♀️ = Draft Guide Take the write up, put it in the Guide template and screen shots (or notes that screen shots are needed) and start working on the language.
    🎉= Completed Guide

    Location of draft guide.

    • Epic Issue #[insert number of Epic here]
    • 👷‍♀️[INSERT NAME OF DRAFT GUIDE]

  2. ExperimentsInHonesty commented on Oct 2, 2021

    @ExperimentsInHonesty
    ExperimentsInHonesty
    on Oct 2, 2021
    MemberAuthor

    Potential text for Epic issue

    Title: Workflow Modeling: [name of technology]
    Beginning Label: Setup Epic

    Overview

    We need to model the workflows of [name technology] so that we can create guide making issues.

    Action Items

    • Setup Items
      • Check to see if there is a label for the epic, and if not create a label for [name of technology] (e.g., 1password, GithHub, Google Drive)
      • Create folder for guides
      • Create folder for recordings
    • Setup complete
      • remove label: "Status: Setup Epic" add label "Status: Make Appt"
    • Make appointment with member of admin team who is currently performing function (see resources).
      • remove label: "Status: Make Appt" add label "Status: Recording Tool Overview"
    • Record reviewing the application with member of admin team who is currently performing function to determine all features we are using and might use.
      • remove label: "Recording Tool Overview" add label "Status: Upload Overview"
    • Upload recording and transcripts to its folder.
      • remove label: Status: Upload Overview" and add label "Status: Identify Workflows
    • create a list of workflows that will not need guides at this time and define the reason why (decision record).
    • create a list of all workflows that will need guides.
    • create folders inside the guides and recordings folders for each workflow
      • remove label: "Status: Identify workflows - Admin" and add label: "Status: Create Issues from Epic"
      • create issues for each workflow (using the guides creation template).
        • remove label: "Status: Create Issues from Epic" add label: "Status: Monitor Epic" and move to Start Here column
    • Add this epics label to the tracker. - on hold for now

    Resources

    • Admin team member currently performing function:

    • [Guide Creation Issue template]

    Folders

    • Recordings & Transcripts
      • 📁Recordings general folder
      • 📁[INSERT NAME OF THE FOLDER YOU WILL CREATE]
      • Link to specific recording and transcript (add links to the emojis)
        • ⏺️
        • ✏️
    • Guides

    Legend

    📁 = Folder
    ✏️= Transcription
    ⏺️ = Recording
    📝 = "As-Is": Transcript edited down to steps (no pictures, no focus on writing instructions for others)
    👷‍♀️ = Draft Guide Take the write up, put it in the Guide template and screen shots (or notes that screen shots are needed) and start working on the language.
    🎉= Completed Guide

    Workflows that need guides now

    Workflows that don't need guides now

    • Name of Workflow:
      • Decision Record:

  3. kcoronel commented on Oct 9, 2021

    @kcoronel
    kcoronel
    on Oct 9, 2021 · Hidden as resolved
  4. ExperimentsInHonesty
    added
    epic
    epic: templates for issue format
    on Oct 9, 2021

  5. ExperimentsInHonesty commented on Oct 11, 2021

    @ExperimentsInHonesty
    ExperimentsInHonesty
    on Oct 11, 2021 · Hidden as resolved
    Author

  6. ExperimentsInHonesty commented on Oct 11, 2021

    @ExperimentsInHonesty
    ExperimentsInHonesty
    on Oct 11, 2021 · Hidden as resolved
    Author

  7. ExperimentsInHonesty commented on Dec 4, 2021

    @ExperimentsInHonesty
    ExperimentsInHonesty
    on Dec 4, 2021
    MemberAuthor
    • we need to go through all the issues that have already been made and make sure they have the correct labels and that the named epics label is the right color.
  8. kcoronel
    closed this as completedon Jan 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    epicepic: templates for issue format

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions