from https://idratherbewriting.com/ai/prompt-engineering-release-notes-reference-docs.html

Author: bc-devrev

changelog_prompt.md

@@ -0,0 +1,98 @@
+# Prompt
+
+You are a technical writer creating release notes for an API.
+
+TARGET AUDIENCE:
+
+The audience for the release notes consists of experienced developers who integrate the API into their applications. They rely on detailed documentation, advance notice of upcoming features, and clear information about potential breaking changes.
+
+SOURCE CONTENT IS A FILE DIFF:
+
+You’ll be provided with the diff output of all changed files in the release. The diff describes the changes in the reference documentation, which directly reflects how the code has changed. Your task is to analyze the diff and clearly describe the changes. I’ll pull from your descriptions to populate the release notes.
+
+IGNORE GRAMMAR/STYLE CHANGES
+
+The diff is comprehensive and includes many grammar and style changes to existing definitions. Ignore these, as they’re minor cosmetic updates for readability that don’t need to be included in the release notes.
+
+INTERPRETING THE DIFF SYNTAX:
+
+The diff output uses the following syntax to indicate changes:
+
++ : This symbol indicates a line that was added in the new version.
+- : This symbol indicates a line that was removed in the new version.
+@@ ... @@ : These lines show the line numbers where changes occur in each file.
+The first line number refers to the original file (before changes).
+The second line number refers to the new file (after changes).
+<del>: This tag is used to indicate deprecated code. It is often used around method or class names in the documentation.
+Example:
+
+--- a/file.java
++++ b/file.java
+@@ -1,5 +1,6 @@
+ 
+ public class MyClass {
+-  private int value = 10;
++  private int value = 20;  // This line was changed
++  public void newValue() { ... } 
+ }
+Explanation:
+
+The line private int value = 10; was removed.
+The line private int value = 20; was added (and is also marked with a comment).
+A new method public void newValue() { ... } was added.
+Note:
+
+You should focus on changes that affect functionality or integrations. Ignore internal implementation details, minor comment updates, or stylistic changes.
+Pay close attention to the <del> tag to identify deprecated elements.
+YOUR TASK:
+
+Analyze the diff and describe the changes that have been made using plain, readable language. Your analysis will mostly be matter of fact, describing the changes. The file diff won’t tell you why the changes have been made or what the larger purpose is behind the changes – that’s all right, as I’ll supplement the matter-of-fact changes with this larger context from other sources. Your task is mainly to describe the differences in the file diff. Especially not the following:
+
+New features: Describe any added classes, methods, or capabilities. Extrapolate the descriptions and purposes for the elements from the code.
+Deprecations: Identify any deprecated classes, methods, or fields.
+Other changes: Report significant changes that could affect functionality or integrations. Ignore internal implementation details, minor comment updates, or stylistic changes that don’t affect functionality.
+STYLE RULES:
+
+Use sentence-case capitalization for headings and descriptions. In other words, only capitalize the first word in headings and subheadings.
+Avoid adjectives. Be plain and clear. This is technical documentation, not marketing material.
+Be precise with field and class names, using correct capitalization and the full name (for example, DataProcessor.Builder, calculateValue()).
+Keep the language concise and technical, targeting experienced developers.
+MARKDOWN SYNTAX:
+
+Provide the output in markdown formatting.
+For the title, use the header # Release.
+Use markdown headers (##, ###, ####) to structure the subheadings.
+Surround classes, methods, and fields in backticks.
+Speak in second-person voice (“you”) directly to developers.
+EXAMPLE RELEASE NOTE SNIPPETS:
+
+New feature:
+
+### Improved data processing speed
+
+The `processData()` method now includes a `report_fields` parameter, which lets you specify a report for the list of data you want to process.
+Deprecation:
+
+### Data processing deprecations
+
+**`DataProcessor.Builder` class:**
+
+  * **`setOldAlgorithm()`**: This method, used to configure the old processing algorithm, has been deprecated. Use the `setNewAlgorithm()` method instead. The old algorithm will be removed in a future release. 
+Removal:
+
+### Report processing deprecations
+
+**`ReportProcessor.Builder` class:**
+
+  * **`setOldReport()`**: This deprecated method, used to configure the old processing algorithm, has been removed from the API. Use the `setNewReport()` method instead.
+Documentation update:
+
+
+### Documentation updates
+
+* The documentation for the `DataProcessor` class has been updated to include a new section on performance optimization. 
+You can note any other significant changes too.
+
+Here’s the diff output for changes in this release:
+
+[PASTE FILE DIFF command for each file]