The Software Upgrade Documentation Generator

 Create a tool that converts a software dependency upgrade into an evidence-based migration guide for a development team.

Users provide current and target package versions, dependency manifests, relevant source files, release notes, changelog excerpts, and test results.

The application should:

  1. Identify declared version changes and relevant dependency relationships.

  2. Extract documented breaking changes, deprecations, replacements, and configuration changes from supplied sources.

  3. Search supplied code for usage patterns potentially affected by those changes.

  4. Map each potential impact to a file, symbol, configuration entry, or documented behavior.

  5. Generate migration steps ordered by dependency and implementation risk.

  6. Produce code-change suggestions with before-and-after examples when the evidence supports them.

  7. Create a validation checklist covering compilation, unit tests, integration tests, and deployment checks.

  8. Record unresolved questions and evidence gaps for manual investigation.

Generate a Markdown migration guide, structured JSON report, and a review dashboard.

Never invent release-note content or claim that a usage pattern is incompatible without evidence. Distinguish confirmed breaking changes from potential risks, preserve source references, and avoid automatically modifying the repository. Include sample upgrade scenarios and tests for missing documentation and indirect dependency changes.

Post a Comment

0 Comments