export-work-items
Generate markdown reports of work items with optional details like acceptance criteria, descriptions, and comments. Use when creating sprint summaries, feature overviews, or documenting requirements.
When & Why to Use This Skill
This Claude skill automates the generation of comprehensive Markdown reports from Azure DevOps work items. It allows users to seamlessly export task details, acceptance criteria, and discussion comments into a clean, portable format, making it an essential tool for creating sprint summaries, feature documentation, and sharing project progress with stakeholders who may not have direct access to DevOps platforms.
Use Cases
- Sprint Summaries: Automatically compile all completed work items into a formatted Markdown report for end-of-sprint reviews and stakeholder updates.
- Requirement Documentation: Export User Stories and their associated acceptance criteria to create centralized, version-controlled requirement documents.
- External Collaboration: Share specific work item details, including descriptions and comments, with external partners or team members without requiring Azure DevOps licenses.
- Feature Overviews: Consolidate multiple related work items into a single document to provide a high-level technical or functional overview of a new feature's implementation.
| name | export-work-items |
|---|---|
| description | Generate markdown reports of work items with optional details like acceptance criteria, descriptions, and comments. Use when creating sprint summaries, feature overviews, or documenting requirements. |
Export Work Items to Markdown
Generate markdown reports of work items with optional details like acceptance criteria, descriptions, and comments.
When to Use
- User wants a report or documentation of work items
- Need to share work item details outside Azure DevOps
- Creating sprint summaries or feature overviews
- Documenting requirements or acceptance criteria
Prerequisites
- Azure DevOps must be initialized with
Initialize-AzureDevOps
Examples
Export search results
Search-WorkItems -SearchText "authentication" | Export-WorkItemsToMarkdown -OutputPath "auth-items.md"
Export with acceptance criteria
Search-WorkItems -WorkItemType "User Story" -State "Active" |
Export-WorkItemsToMarkdown -OutputPath "active-stories.md" -IncludeAcceptanceCriteria
Export with full details
Get-WorkItem -Ids 12345,67890 |
Export-WorkItemsToMarkdown -OutputPath "feature-details.md" `
-IncludeDescription `
-IncludeAcceptanceCriteria `
-IncludeComments
Export feature with children
Get-WorkItemsByFeature -SearchText "authentication" |
Export-WorkItemsToMarkdown -OutputPath "auth-feature.md" -IncludeAcceptanceCriteria
Function
Export-WorkItemsToMarkdown
Accepts work items from pipeline and generates markdown report.
Parameters
- WorkItems: Array of work items (from pipeline)
- OutputPath: File path to save markdown (required)
- IncludeAcceptanceCriteria: Include AC in export
- IncludeDescription: Include descriptions
- IncludeComments: Include all comments
Output
Returns object with:
- FilePath: Path to generated file
- ItemCount: Number of items exported
Markdown includes:
- Work item ID and title as headers
- Type, state, assignment
- Tags and links to Azure DevOps
- Optional: description, acceptance criteria, comments
- Formatted for easy reading
Tips for Copilot
- Pipe search results directly to export
- Use IncludeAcceptanceCriteria for requirements docs
- Use IncludeComments for full context
- Good for sprint planning documents
- Helpful for sharing with non-Azure DevOps users