creating-iteration-report

Aggregate iteration plans, git history, and test results into markdown reports.

Updated Apr 10, 2026
One-click install
npx skills add https://github.com/k2works/getting-started-algorithm --skill creating-iteration-report
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: creating-iteration-report
Source: https://github.com/k2works/getting-started-algorithm/tree/main/.agents/skills/creating-iteration-report
Command: npx skills add https://github.com/k2works/getting-started-algorithm --skill creating-iteration-report

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produces a formal, quantitative iteration completion report by automating the collection and synthesis of iteration plans, release plans, git history, and test results so teams no longer assemble metrics and narratives by hand.

Core Features & Use Cases

  • Data aggregation: Collects iteration_plan-{N}.md, release_plan.md, prior iteration reports, git logs, and test outputs to form the factual basis of the report.
  • Metrics & charts: Computes planned vs actual story points, achievement rate, velocity tables, burn-down and velocity charts, and test result summaries for transparency and planning improvement.
  • Repository updates: Writes docs/development/iteration_report-{N}.md, updates release_plan.md progress entries, and refreshes documentation indexes and mkdocs navigation as needed.
  • Use case: At the end of an iteration, run this workflow to generate a reproducible report that supports release planning, retrospectives, and stakeholder updates.

Quick Start

Create an iteration completion report for iteration 4 by aggregating docs/development/iteration_plan-4.md, release_plan.md, git history, and test outputs into docs/development/iteration_report-4.md.

Frequently Asked Questions about creating-iteration-report

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate iteration report generation from git history and test results?

Automate iteration report generation by collecting iteration_plan-{N}.md, release_plan.md, git logs, and test outputs to compute planned vs actual story points, velocity tables, and burn-down charts into a single markdown report.

What is the best way to track velocity and story points for an iteration completion report?

Track velocity and story points by aggregating iteration plans and release plan data to compute achievement rates, velocity tables, and burn-down charts, then write the metrics into docs/development/iteration_report-{N}.md.

Do I need mkdocs to generate iteration completion reports with velocity tracking?

You do not need mkdocs to generate the core iteration report, but the workflow refreshes mkdocs navigation and documentation indexes alongside updating release_plan.md progress entries when the report is written.

Can I use this iteration reporting workflow without a release_plan.md file?

You need docs/development/release_plan.md and docs/development/iteration_plan-{N}.md in your repository, as the workflow aggregates these files with git history and test results to produce the formal iteration completion report.

How to generate a reproducible iteration report for release planning and retrospectives?

Generate a reproducible iteration report by running backend, frontend, and E2E tests to capture results, computing story point metrics, and updating release_plan.md and documentation indexes for release planning and retrospectives.

Why does my iteration report not capture test results and git history correctly?

Iteration report capture fails when the repository lacks the required iteration_plan-{N}.md or release_plan.md files, preventing the workflow from aggregating git logs and running backend, frontend, and E2E tests for the report.