slidict 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31c1ca403d68f971c84728e80c5aafda7af449fa5d7b9b7be6202c49472c615f
-  data.tar.gz: 363578c6cfd6c0da50346204b124d10fa5779e7a0f73b262b0a3f1bd2854266c
+  metadata.gz: ab47129a915cbf21d2a573c0f1d3f9f9b654eb86a6a4226261a94fc44a60ba16
+  data.tar.gz: f0ab819d3077c1bfa36f268dc06939c7f02bd483649be86d360d5558a2dded34
 SHA512:
-  metadata.gz: d58f207c65c0b1e0ea8d0e9369aa40dce69af3e54bcedb56b0932a1b77d32238152e15194bcadfba824442c1bf47550e381ecefde58dc3525838ac42a4ae35d4
-  data.tar.gz: 41cb0a82175bdc62be2369dbe4ef65a3f0a9cf4716b6b0b044bbb8ca0a6aa2c767cf8b829a6f1a8704944b5fd1f5df610b1d3294a7478aa5dd5cd461290d459b
+  metadata.gz: 173dc71c06cf303b382fe7527ec27c8ddb61a9c3ced94563914fe2b56121af308b8d3f6290597800c32086d6ba6b51e8dc91dc1128a6776abf8358e0e1a113dc
+  data.tar.gz: e76f87bdd14452ce271dfa20cf5f8af65c5f82a3b687b53958d8e8a2cf45f022b79ba0ee2dd2dc753a02b1dcb44c4032bee8bfcebb2adbaf7512e77dcba7d68a

data/.github/pull_request_template.md

@@ -0,0 +1,22 @@
+## Summary
+
+<!-- What does this PR change, and why? -->
+
+## Version bump
+
+This repository follows [Semantic Versioning](https://semver.org/) (see `AGENTS.md`).
+Every PR is expected to update `lib/slidict/version.rb`, and CI fails when it does not.
+
+- [ ] <!-- skip-version-check --> This PR does not require a version bump
+
+<!--
+Leave the box above unchecked and bump `lib/slidict/version.rb` in this PR.
+Check it only when no release is needed (docs-only, CI-only, test-only changes, etc.).
+Keep the `skip-version-check` comment intact — the CI check looks for it.
+-->
+
+## Checklist
+
+- [ ] `bundle exec rspec` passes
+- [ ] `bundle exec rubocop` passes
+- [ ] `README.md` updated if user-facing behavior changed

data/.github/workflows/version-check.yml

@@ -0,0 +1,70 @@
+name: Version Check
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - edited
+      - ready_for_review
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  version-file:
+    name: Require version.rb update
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Require version.rb update or an explicit skip
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPO: ${{ github.repository }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          PR_BODY: ${{ github.event.pull_request.body }}
+          PR_ACTOR: ${{ github.event.pull_request.user.login }}
+          VERSION_FILE: lib/slidict/version.rb
+        run: |
+          set -euo pipefail
+
+          # Dependency update PRs are opened by bots that cannot fill in the
+          # pull request template, so they are exempt from this check.
+          case "$PR_ACTOR" in
+            'dependabot[bot]' | 'github-actions[bot]')
+              echo "::notice::Skipping version check for bot author '${PR_ACTOR}'."
+              exit 0
+              ;;
+          esac
+
+          # The pull request template ships a checkbox carrying the
+          # `skip-version-check` marker, unchecked by default.
+          if printf '%s\n' "${PR_BODY:-}" |
+            grep -qiE '^[[:space:]]*[-*+][[:space:]]+\[[[:space:]]*x[[:space:]]*\].*skip-version-check'; then
+            echo "::notice::'${VERSION_FILE}' is not required: the skip-version-check box is checked."
+            exit 0
+          fi
+
+          changed_files="$(gh api --paginate "repos/${REPO}/pulls/${PR_NUMBER}/files" --jq '.[].filename')"
+
+          if printf '%s\n' "$changed_files" | grep -qxF "$VERSION_FILE"; then
+            echo "::notice::'${VERSION_FILE}' is updated in this pull request."
+            exit 0
+          fi
+
+          echo "::error::'${VERSION_FILE}' is not updated in this pull request."
+          {
+            echo "### Version check failed"
+            echo
+            echo "This pull request does not update \`${VERSION_FILE}\`."
+            echo
+            echo "Do one of the following:"
+            echo
+            echo "- Bump \`VERSION\` in \`${VERSION_FILE}\` following [SemVer](https://semver.org/) (see \`AGENTS.md\`), or"
+            echo "- Check the \"This PR does not require a version bump\" box in the pull request description."
+            echo
+            echo "Editing the description re-runs this check automatically."
+          } >> "$GITHUB_STEP_SUMMARY"
+          exit 1

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.7.0] - 2026-07-30
+
+- Add built-in SDS, DESC, AIDMA, TAPS, and FABE presentation methods.
 - Add source-text slide generation through `--text`, `--text-file`, and the reusable
   `Slidict::Generator` integration API.
 - Add `slidict init` to create a `.env` file (for `SLIDICT_LLM_*`, `SLIDICT_FRAMEWORK`,

data/README.md

@@ -299,10 +299,12 @@ We optimize for communication, not decoration.
 
 ## Presentation methods
 
-Use `--method` to generate slides with a specific narrative structure, such as SCQA, PREP, or Pyramid Principle.
+Use `--method` to generate slides with a specific narrative structure. Built-in methods include SDS, PREP, DESC,
+AIDMA, TAPS, FABE, SCQA, and Pyramid Principle.
 
 ```bash
 bin/slidict --method scqa --topic "Database migration plan"
+bin/slidict --method aidma --topic "Product launch"
 bin/slidict list-methods
 bin/slidict show-method scqa
 ```

data/data/slidict/methods/aidma.yml

@@ -0,0 +1,35 @@
+id: aidma
+name: AIDMA
+category: marketing
+description: Attention, Interest, Desire, Memory, Action structure for guiding an audience from awareness to action.
+locale: en
+suitable_for:
+  - Marketing presentations
+  - Product and service pitches
+  - Campaign or launch proposals
+slides:
+  - title: Attention
+    role: Capture attention with an audience-relevant hook.
+    instructions: Open with a striking fact, question, or situation connected to the audience's needs.
+  - title: Interest
+    role: Build interest by showing why the subject is relevant.
+    instructions: Connect the offer or idea to a recognizable problem, opportunity, or aspiration.
+  - title: Desire
+    role: Turn interest into a preference for the proposed solution.
+    instructions: Show concrete benefits and help the audience imagine the improved outcome.
+  - title: Memory
+    role: Make the key message easy to recall.
+    instructions: Reinforce one distinctive promise with memorable evidence, phrasing, or imagery.
+  - title: Action
+    role: Prompt the audience to take a clear next step.
+    instructions: State one specific action, remove ambiguity, and explain what happens next.
+ai_instructions:
+  - Move through the AIDMA stages in order without asking for action too early.
+  - Frame benefits from the audience's point of view.
+  - Keep the memorable promise consistent with the evidence and call to action.
+review_checklist:
+  - Does the opening earn the target audience's attention?
+  - Does interest develop into a concrete desire?
+  - Is the central promise distinctive and memorable?
+  - Is the requested action specific and easy to understand?
+references: []

data/data/slidict/methods/desc.yml

@@ -0,0 +1,32 @@
+id: desc
+name: DESC
+category: assertive-communication
+description: Describe, Express, Specify, Consequences structure for proposing a constructive change or resolving conflict.
+locale: en
+suitable_for:
+  - Feedback and difficult conversations
+  - Conflict resolution
+  - Requests for behavioral or process change
+slides:
+  - title: Describe
+    role: Describe the situation or behavior objectively.
+    instructions: State observable facts without blame, assumptions, or judgment.
+  - title: Express
+    role: Explain the impact and the speaker's perspective or feelings.
+    instructions: Use specific first-person language to show why the situation matters.
+  - title: Specify
+    role: Request a concrete and achievable change.
+    instructions: Define the desired behavior, owner, and timing so the request is actionable.
+  - title: Consequences
+    role: Clarify the positive outcomes of the change and the implications of inaction.
+    instructions: Emphasize realistic benefits and consequences rather than threats.
+ai_instructions:
+  - Separate observable facts from interpretations and emotions.
+  - Keep the tone respectful, direct, and solution-oriented.
+  - Make the requested change specific enough to act on.
+review_checklist:
+  - Is the description factual and nonjudgmental?
+  - Is the impact expressed clearly from the speaker's perspective?
+  - Is the requested change concrete and achievable?
+  - Are the consequences realistic and constructive?
+references: []

data/data/slidict/methods/fabe.yml

@@ -0,0 +1,32 @@
+id: fabe
+name: FABE
+category: sales
+description: Features, Advantages, Benefits, Evidence structure for connecting an offering's capabilities to credible customer value.
+locale: en
+suitable_for:
+  - Sales presentations
+  - Product demonstrations
+  - Solution comparisons
+slides:
+  - title: Features
+    role: Introduce the relevant capabilities or attributes of the offering.
+    instructions: Select only features connected to the audience's needs and describe them precisely.
+  - title: Advantages
+    role: Explain how those features perform better or differently.
+    instructions: Compare the capabilities with the current approach or alternatives without unsupported claims.
+  - title: Benefits
+    role: Translate the advantages into outcomes the audience values.
+    instructions: State tangible functional or emotional value in the audience's terms.
+  - title: Evidence
+    role: Prove the promised benefits with credible support.
+    instructions: Use relevant data, demonstrations, testimonials, or case results and identify their context.
+ai_instructions:
+  - Maintain a clear chain from each feature to its advantage, benefit, and evidence.
+  - Prioritize audience value over a long inventory of specifications.
+  - Avoid claims that the evidence does not substantiate.
+review_checklist:
+  - Are the selected features relevant to the audience's needs?
+  - Are advantages differentiated clearly and fairly?
+  - Are benefits expressed as audience outcomes?
+  - Is every important claim supported by credible evidence?
+references: []

data/data/slidict/methods/sds.yml

@@ -0,0 +1,28 @@
+id: sds
+name: SDS
+category: concise-communication
+description: Summary, Details, Summary structure for communicating a message clearly and memorably.
+locale: en
+suitable_for:
+  - Short presentations and status updates
+  - Explanations that need a clear takeaway
+  - Messages for time-constrained audiences
+slides:
+  - title: Summary
+    role: State the central message or conclusion at the outset.
+    instructions: Give the audience a concise overview of what they should understand or remember.
+  - title: Details
+    role: Support the opening summary with the essential facts, reasoning, or examples.
+    instructions: Present only the details needed to substantiate the central message, in a logical order.
+  - title: Summary Revisited
+    role: Reinforce the central message after the supporting detail.
+    instructions: Restate the takeaway in fresh, concise language and connect it to the desired response.
+ai_instructions:
+  - Preserve the Summary, Details, Summary sequence.
+  - Keep the opening and closing summaries consistent while avoiding word-for-word repetition.
+  - Include only details that directly support the central message.
+review_checklist:
+  - Is the central message clear in the opening summary?
+  - Do all details support that message?
+  - Does the closing summary reinforce the intended takeaway?
+references: []

data/data/slidict/methods/taps.yml

@@ -0,0 +1,32 @@
+id: taps
+name: TAPS
+category: problem-solving
+description: To Be, As Is, Problem, Solution structure for defining a desired state and the change needed to reach it.
+locale: en
+suitable_for:
+  - Improvement proposals
+  - Transformation roadmaps
+  - Problem-solving presentations
+slides:
+  - title: To Be
+    role: Define the desired future state and its success criteria.
+    instructions: Describe a concrete, audience-relevant outcome rather than a vague aspiration.
+  - title: As Is
+    role: Establish the current state with objective evidence.
+    instructions: Show the present performance or behavior using facts that can be compared with the desired state.
+  - title: Problem
+    role: Identify the gap and the factors preventing progress.
+    instructions: Explain the most important root cause or barrier, not merely its symptoms.
+  - title: Solution
+    role: Present the actions that will close the gap.
+    instructions: Connect each proposed action to the identified problem and specify the immediate next step.
+ai_instructions:
+  - Make the gap between To Be and As Is explicit and measurable where possible.
+  - Distinguish root causes from symptoms.
+  - Ensure the solution directly addresses the stated problem.
+review_checklist:
+  - Is the desired state concrete and relevant?
+  - Is the current state supported by evidence?
+  - Does the problem explain the gap between the two states?
+  - Does the solution address the root cause and define a next step?
+references: []

data/docs/presentation-methods.md

@@ -10,11 +10,13 @@ gem only loads, validates, and applies that data.
 bin/slidict new --method prep --topic "New onboarding flow"
 bin/slidict --method scqa --topic "Database migration plan"
 bin/slidict --method pyramid --topic "FY roadmap recommendation"
+bin/slidict --method fabe --topic "Customer analytics platform"
 bin/slidict list-methods
 bin/slidict show-method scqa
 ```
 
-Built-in methods currently include SCQA, PREP, and Pyramid Principle.
+Built-in methods currently include SDS, PREP, DESC, AIDMA, TAPS, FABE, SCQA,
+and Pyramid Principle.
 
 ## Architecture
 
@@ -32,9 +34,14 @@ This keeps contribution review small: a new built-in method is usually one YAML
 
 ```text
 data/slidict/methods/
+  aidma.yml
+  desc.yml
+  fabe.yml
   prep.yml
   pyramid.yml
   scqa.yml
+  sds.yml
+  taps.yml
 lib/slidict/presentation_method.rb
 ```
 

data/lib/slidict/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slidict
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slidict
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Yusuke Abe
@@ -60,11 +60,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/pull_request_template.md"
 - ".github/release-drafter.yml"
 - ".github/workflows/bump-version.yml"
 - ".github/workflows/changelog.yml"
 - ".github/workflows/gem-push.yml"
 - ".github/workflows/test.yml"
+- ".github/workflows/version-check.yml"
 - AGENTS.md
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -72,9 +74,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- data/slidict/methods/aidma.yml
+- data/slidict/methods/desc.yml
+- data/slidict/methods/fabe.yml
 - data/slidict/methods/prep.yml
 - data/slidict/methods/pyramid.yml
 - data/slidict/methods/scqa.yml
+- data/slidict/methods/sds.yml
+- data/slidict/methods/taps.yml
 - docs/demo-methods.gif
 - docs/demo-methods.tape
 - docs/demo.gif