FJAN Logo

Getting Started with Checklist Extension for Azure DevOps

Welcome to the Checklist Extension Azure DevOps! This guide will help you get started with using the extension effectively.

Installation

To install the Checklist Extension for Azure DevOps, follow these steps:

  1. Open your Azure DevOps organization.
  2. Navigate to the "Marketplace" section.
  3. Search for "Checklist Extension for Azure DevOps".
  4. Click on "Install" and follow the prompts to add it to your project.

Configuration

After installation, you need to set up custom fields to store checklist data. Note: You can only add custom fields to custom processes, not system processes.

Step 1: Create or Use a Custom Process

Important

You cannot modify system processes (Agile, Scrum, CMMI, Basic) directly. You need to create an inherited process to add custom fields.

  1. Navigate to your Organization Settings in Azure DevOps
  2. Under "Boards", click on Process
  3. Find the system process your project currently uses (e.g., Agile, Scrum, CMMI, Basic)
  4. Click the ellipsis (⋯) button next to the system process
  5. Select "Create inherited process"
  6. Give it a name (e.g., "Custom Agile with Checklists")
  7. Click "Create process"
  8. Go to your Project Settings → Project configuration → Process and change to your new inherited process

Step 2: Create Custom Fields for Checklists

  1. In your inherited process, choose a work item type where you want to add checklists (e.g., User Story, Task, Bug)
  2. Click "New field"
  3. Configure the field:
    • Name: Enter a descriptive name (e.g., "Definition of Done Checklist", "Code Review Checklist")
    • Type: Select "Text (Multi line)"
    • Description: Add a helpful description for your team (optional)
  5. Under "Layout", create a new group:
    • Click "Create new group"
    • Name it something like "Checklists" or "Process Tracking"
  7. Click "Add field" to save

Step 3: Hide the Field from Standard View (Optional)

Since the extension will display the checklist in a user-friendly format, you may want to hide the raw markdown field:

  1. In the work item type layout, find your newly created field
  2. Click the ellipsis (⋯) button next to the field
  3. Select "Hide from layout"
  4. The field will still store data but won't clutter the work item form

Step 4: Extension Configuration

After creating the custom fields, configure the extension by:

  • Accessing the extension settings from the project settings menu
  • Mapping your custom fields to checklist templates
  • Creating reusable checklist templates for different scenarios
  • Applying multiple templates to the same work item type if needed
  • Each template needs its own Work Item Field

Usage

To use the checklist feature:

  1. Create or open a work item where you want to use a checklist.
  2. Check the items as you track your progress.
  3. Skip items when not relevant.

Best Practices

Pro Tips

  • Naming Convention: Use descriptive field names like "DoD Checklist" or "Security Review Checklist"
  • Multiple Checklists: Create separate fields for different types of checklists (e.g., development, testing, deployment)
  • Team Alignment: Involve your team in defining checklist templates to ensure adoption
  • Regular Review: Periodically review and update your checklist templates based on team feedback

Common Use Cases

  • Definition of Done: Ensure all completion criteria are met before marking items as done
  • Code Review Checklists: Standardize code review processes across your team
  • Deployment Procedures: Track deployment steps and ensure nothing is missed
  • Testing Protocols: Maintain consistent testing procedures for different work item types

Support

If you encounter any issues or have questions, please refer to our documentation or contact support through the Azure DevOps Marketplace page.