DOCSHOW TO USE YAKSHAVER - SETUP & GUIDE

How to use YakShaver - Setup & Guide

YakShaver streamlines work item creation by converting your screen recordings into structured documentation. Choose your preferred recording method below and follow the setup instructions to get started. For the best experience, we recommend starting with Microsoft Teams or the browser extension.

Microsoft Teams Setup

Teams integration provides seamless collaboration features and is perfect for team environments.

Installation Steps

  1. In Microsoft Teams, click Apps on the left sidebar
  2. Search for "YakShaver" in the search box
  3. Click Add to install the YakShaver bot
  4. Right-click YakShaver and select "Pin" to keep it on your sidebar

Image

Figure: Adding YakShaver bot to Teams

Initial Configuration

  1. Go to YakShaver bot in your Teams sidebar
  2. Type 'on' in the chatbox to activate automatic processing
  3. You'll see a confirmation card when YakShaver is active

Image

Figure: YakShaver activation confirmation

Available Commands

  • on - Set YakShaver to always process your videos
  • off - Set YakShaver to ask before processing
  • status - Check your current settings
  • leaderboard - View the leaderboard
  • help - Show list of commands
  • hi - Display welcome message

πŸ“– Ready to record in Teams? See our Teams Recording Guide

Browser Extension Setup

The browser extension offers seamless integration with Chrome and Edge browsers.

Installation Steps

  1. Visit YakShaver landing page and click "Try it now"
  2. Add the extension to Chrome/Edge
    Image

Figure: Installing and pinning the YakShaver browser extension

3. Pin it to your browser toolbar for easy access

4. Allow any required permissions when prompted

πŸ’‘ Important Notes:

  • Make sure you're on a recordable page before starting (browser system pages like chrome://extensions aren't supported)
  • For optimal results, ensure your microphone permissions are enabled
  • The extension works best with Chrome or Edge browsers

πŸ“– Ready to start recording? Check out our detailed Recording Guide for Browser Extension

Third-Party Tools Setup

YakShaver supports various recording tools for users who prefer their existing workflow or need specific features.

Supported Tools

  • Snagit - Professional screen capture tool (Recommended for Windows)
    • Offers advanced editing features
    • Supports custom keyboard shortcuts
    • Perfect for power users
  • Windows Snipping Tool - Built-in Windows tool
    • No additional software required
    • Quick and easy to use
    • Windows key + Shift + R shortcut
  • Mac Screenshot App - Built-in MacOS tool
    • Native MacOS integration
    • CMD + Shift + 5 shortcut
    • No additional software needed

General Setup Process

  1. Create a dedicated folder in your OneDrive:
    • For Snagit: OneDrive/Recordings/Snagit/
    • For Snipping Tool: OneDrive/Recordings/SnippingTool/
    • For Screenshot App: OneDrive/Recordings/ScreenshotApp/
  2. Configure your tool to save recordings to the appropriate folder
  3. Ensure your microphone is properly set up
  4. Test a recording to verify the setup

πŸ“– For detailed setup instructions, visit:

Additional Resources

πŸ’‘ Pro Tips:

  • Always start your recording by clearly stating the purpose
  • For bug reports, include reproduction steps and expected behavior
  • Mention team members who should be notified (e.g., "Cc @username")
  • You can convert email tasks to work items after creation if needed
  • Videos are securely hosted on SharePoint or YouTube based on your preference
Last Updated: 15 January 2025