Skip to content

JTBD Automation#304

Open
anarnold97 wants to merge 2 commits intomigtools:mainfrom
anarnold97:JTBD-automation
Open

JTBD Automation#304
anarnold97 wants to merge 2 commits intomigtools:mainfrom
anarnold97:JTBD-automation

Conversation

@anarnold97
Copy link
Copy Markdown
Contributor

@anarnold97 anarnold97 commented Feb 6, 2026

How the PR Relates to the Ecosystem

1. Strategy-to-Content Alignment

This PR ensures that your documentation is no longer just a collection of technical features. By injecting the Statement and Persona into the files, you are forcing the documentation to answer the question: "What is the user actually trying to achieve?" * Before: An assembly might describe "How to use the CLI."

  • After: The assembly is tagged with a JTBD job like "Estimate migration effort," refocusing the content on the outcome (estimation) rather than the tool (CLI).

2. Standardizing Quality (CQA 2.1)

The PR automates compliance with Content Quality Architecture (CQA) 2.1. It acts as a "linter" for your abstracts by:

  • Enforcing a length between 50 and 300 characters.
  • Standardizing the tone to be user-centric (converting "I want to..." into "So you can...").

3. Traceability and Maintenance

By adding the // JTBD job: <id> comments, this PR creates a traceable link between your documentation files and your product roadmap.

  • Auditability: You can now run a simple grep or use the script's --report flag to see exactly which files support which user jobs.
  • Gap Analysis: If a critical user job (e.g., "Securing the migration") has no files mapped to it, the gap becomes immediately visible.

The Data Flow Relationship

  1. Input (The Goal): docs/jtbd-mapping.yaml defines the intent.
  2. Transformation (The Logic): scripts/jtbd_apply_mapping.py processes the logic.
  3. Output (The User Experience): The .adoc files are updated, which ultimately changes the Search Result Snippets and Introduction Paragraphs that customers see on the live portal.

What this PR "Fixes"

If you are reviewing this PR, you are likely addressing these common documentation "pain points":

  • Vague Abstracts: Replacing "This section covers the CLI" with "Learn how to identify migration risks so you can plan your project effort."
  • Persona Drift: Ensuring that a "Developer" persona isn't being served "Administrator" level instructions.
  • Manual Overhead: Eliminating the need for writers to manually count characters or copy-paste JTBD statements from a master list.

Signed-off-by: A.Arnold <anarnold@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant