{
  "schema_version": 2,
  "kind": "shortening-method",
  "format": "agent-skill",
  "id": "release-notes",
  "name": "Release notes",
  "category": "Technical",
  "summary": "Describe the change and what users need to do.",
  "use_cases": [
    "Changelogs",
    "Product updates",
    "Migration announcements"
  ],
  "word_count": 112,
  "url": "https://sho.rten.it/methods/release-notes/",
  "instructions_url": "https://sho.rten.it/methods/release-notes/SKILL.md",
  "skill_url": "https://sho.rten.it/methods/release-notes/SKILL.md",
  "json_url": "https://sho.rten.it/methods/release-notes/llms.txt",
  "plain_text_url": "https://sho.rten.it/methods/release-notes/prompt.txt",
  "license": "MIT",
  "sources_url": "https://sho.rten.it/sources/#release-notes",
  "skill_name": "release-notes",
  "skill_description": "Describe the change and what users need to do. Use for Changelogs, Product updates, Migration announcements.",
  "agents_md_url": "https://sho.rten.it/methods/release-notes/AGENTS.md",
  "sources": [],
  "instructions": "Rewrite the supplied changes as concise release notes for the intended users. State what changed and how it affects them. Group related changes and remove duplicate descriptions. Prefer specific verbs such as added, fixed, or removed to vague claims of improvement.\n\nKeep breaking changes, affected versions, availability limits, known issues, and required migration steps prominent. Preserve exact product names, settings, commands, and links. Include implementation details only when users need them to understand or act on the change.\n\nDo not invent benefits, performance gains, availability, or fixes. Do not describe planned work as released. Keep each distinct user-relevant change. Use short bullets unless another format is requested. Return only the release notes.",
  "example": {
    "context": "Release notes with a breaking command change and unresolved limit",
    "before": "Note Desk 2.6 is now released. CSV exports created by workspace administrators now include archived projects; exports already downloaded are unchanged. We also fixed a bug that removed labels when users restored archived notes. The legacy export command export-notes --all has been removed in this version, so scripts must use export-notes --include-archived instead. Guests still cannot export. A known issue remains: exports above 50,000 notes can time out. Background export jobs are planned for a later version and are not part of 2.6.",
    "after": "- Note Desk 2.6: Administrator CSV exports now include archived projects; existing downloads are unchanged. Guests still cannot export.\n- Fixed labels disappearing when archived notes are restored.\n- Breaking: Replace removed export-notes --all with export-notes --include-archived in scripts.\n- Known issue: Exports above 50,000 notes can time out. Background exports are planned, not included in 2.6.",
    "must_preserve": [
      "Note Desk 2.6 released",
      "Administrator CSV exports include archived projects; previous downloads unchanged; guests still excluded",
      "Archived-note restore labels fixed",
      "Removed export-notes --all; required export-notes --include-archived replacement",
      "Known timeout risk above 50,000 notes",
      "Background exports planned for later, not released"
    ],
    "omitted": [
      "Drops internal change narration and groups export restrictions with the affected feature."
    ],
    "kind": "illustrative"
  }
}