Lorixen.
EN

Replacement Downloads: Name the New File and Keep a Readable Change Summary

A button labelled Download latest looks tidy until someone asks which latest they got, and whether it replaces the copy already sitting in their folder. This article proposes a publication workflow for resource downloads where a file is replaced. It is an editorial example with invented sample files, not a report of real results.

The artifact: a download card

Each downloadable item gets a small card with five fields.

  1. File title, written as a plain name.
  2. Edition label, such as Edition 2 or a date you choose and apply consistently.
  3. Status: Current, Replaced, or Withdrawn.
  4. Change summary, written for a reader, not a developer.
  5. Replaces: the previous edition label, or None.

The file name itself should carry the edition label, so a saved copy is identifiable outside your website.

Inputs

Imagine a made up Seed Planting Planner for a community garden club. Edition 1 is published. A corrected Edition 2 is ready. You need both files, the edition labels, the reason for the change, and a decision on whether people holding Edition 1 should stop using it.

Decision branches

  • Minor wording fix that changes nothing a reader would act on: publish a new edition label, mark the old one Replaced, and say so in one sentence. Whether to keep the old file available is your choice.
  • Content change that affects what someone would do: mark the old edition Replaced, state clearly what differs, and keep its card visible so people with the old copy can recognise it.
  • Error serious enough that the old file should not be used: mark it Withdrawn, explain the reason in plain words, and remove the download button while keeping the card.
  • No reader visible difference, such as a file size reduction: do not claim a content change. Say the content is unchanged.

Writing the change summary

Keep it to a few sentences. Name where the change is, say what it was before and what it is now, and say whether earlier copies remain usable. Avoid vague phrases like various improvements. For the sample planner: Page 4 sowing table corrected. The row for the second herb listed the wrong month range. Other pages are unchanged. Please use Edition 2.

Only describe changes you actually made. If you are unsure what changed between files, compare them and record the difference before publishing, or state that you did not compare them.

Stop conditions

Do not publish the replacement if you cannot say what changed, if the edition label would duplicate an existing one, or if the new file name does not carry its label. Stop and fix the record first. Also stop if removing the old file would break a link someone relies on; point that link to the card instead of leaving an error.

Worked example

The card for the sample planner reads: Seed Planting Planner, Edition 2, Status Current, Replaces Edition 1. Change summary as above. Beneath it, a collapsed section called Previous editions lists Edition 1 with status Replaced and its summary of why. The file names are seed-planting-planner-edition-2.pdf and seed-planting-planner-edition-1.pdf.

A visitor who downloaded Edition 1 earlier returns, sees the card, finds Edition 1 marked Replaced, reads the change in seconds, and knows to switch.

Avoid ambiguous controls

If you must keep a single Download button, label it with the edition: Download Edition 2. Do not make an old link silently serve a new file, because a person who shared the link may expect the original.

Acceptance test

With the two sample files and one tester who has not seen the page:

  1. Ask the tester to find the current edition and download it. Confirm the saved file name shows Edition 2.
  2. Ask which edition it replaces and why. They should answer from the card alone.
  3. Ask them to find Edition 1. Confirm it is marked Replaced and its summary is readable.
  4. Change Edition 1 to Withdrawn in a test copy. Confirm the button disappears, the card stays, and the reason is visible.
  5. Open an old link to Edition 1. Confirm it reaches either the file or the card, never an error.
  6. Read the change summary and check each statement against the real difference between the files.

Pass if every question is answered without guessing.

Conclusion

Replacing a file is a small publication event. Name the new edition, say what changed, record what it replaced, and give people a way to recognise the copy they already hold.

Sources

    WhatsAppLet’s talk