Make a template for guide creation

[ExperimentsInHonesty]

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

• [x] Review current method used during creation of 1Password guides and make a template from that
• [x] Make clear to make separate guides for processes and sub processes.
• [x] Decide what labels are needed and add them to the repo
• [x] 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

[ExperimentsInHonesty]

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

• Template for creating guides - WIP
  • UI/UX for Guides

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]

[ExperimentsInHonesty]

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
  • 📁Guides general folder
  • 📁[INSERT NAME AND LINK OF THE FOLDER YOU WILL CREATE]

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:

[kcoronel]

For epic issue: hyperlink to label tracker, add a description for the emojis

For guides issue: give title what is the difference between write up and guide?

[ExperimentsInHonesty]

@kcoronel Writeup = "As-Is" state = 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.

[ExperimentsInHonesty]

@kcoronel I finished creating all the labels we need and made sure that each of the templates has the labels that match the actions. These are ready to be made into "templates" - We can do that next week

[ExperimentsInHonesty]

• [x] 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.