Retro

Спецификация ICUS-214 — User Stories for FAQ Schema

Источник: PDF, приложенный к Jira-задаче https://cpcs.atlassian.net/browse/ICUS-214 (parent для ICUS-216, под которую был сделан PR #837).

Метаданные вложения

  • Файл: User Stories for FAQ Schema - Copy.pdf
  • Кем добавлен: Andrii Holubets (наш менеджер)
  • Когда добавлен: 2026-03-11, 16:34 (Europe/Warsaw)
  • Размер: ~153 KB

Хронология

ДатаСобытие
2026-03-11, 16:34Андрей приложил PDF со спекой к ICUS-214
2026-03-13 (пт)Иван открыл PR #837 (через ~2 дня)
2026-03-17 (вт)Michael Forbes указал на расхождение с acceptance criteria
2026-03-19 (чт)Иван привёл реализацию в соответствие со спекой

Ключевой факт: спека была доступна в Jira за 2 дня до открытия PR. Это исключает версию "спека появилась поздно / после старта".

Business Objective

Enable content owners to generate valid FAQ structured data (FAQPage schema) when the Accordion module is used specifically for FAQs.

User Story 1.0 — Designate Accordion as FAQ

As a Content Owner, I want to mark an Accordion module as "FAQ", so that the system generates appropriate FAQ schema markup.

Acceptance Criteria

  1. Accordion content type includes a new field:
    • Field name: Accordion Purpose
    • Type: Single select
      • Options:
        • Standard Content (default)
        • FAQ
  2. Default value = Standard Content.
  3. FAQ schema is generated only when: Accordion Purpose = FAQ
  4. No schema markup is generated when: Accordion Purpose = Standard Content
  5. Existing Accordion instances default to: Standard Content (no retroactive schema without author action)

User Story 2.0 — Schema QA Validation

As SEO Manager...

Acceptance Criteria

  1. Test page with FAQ accordion → returns valid FAQPage structured data.
  2. Test page with standard accordion → returns schema based on current template.
  3. Multiple FAQ accordions → only one FAQPage schema object present.

User Story 3.0 — Editorial Guidance in CMS

Acceptance Criteria

  1. Help text displayed under "Accordion Purpose": "Select FAQ only when content is a list of user-facing questions and answers."
  2. Governance documentation updated.

User Story 4.0 — Existing Content Handling

Acceptance Criteria

  1. All existing Accordions default to Standard Content.
  2. No automatic schema generation applied retroactively.
  3. Optional report: list of pages likely containing FAQ-style accordions.

Сопоставление "спека ↔ что Михаэль попросил исправить в Comment #5"

Спека (ICUS-214 PDF)Comment #5 (Michael Forbes)Совпадает?
Field name: Accordion PurposeField name: Accordion Purpose✓ дословно
Type: Single selectType: Single select✓ дословно
Options: Standard Content (default), FAQOptions: Standard Content (default), FAQ✓ дословно
Default = Standard ContentDefault = Standard Content✓ дословно
FAQ schema only when Accordion Purpose = FAQFAQ schema only when Accordion Purpose = FAQ✓ дословно
Existing instances default to Standard ContentExisting instances default to Standard Content✓ дословно
Help text: "Select FAQ only when content is a list of user-facing questions and answers."Help text (та же строка)✓ дословно

Вывод: Michael в комментарии ровно цитировал спеку из ICUS-214 — это не его субъективное пожелание, а зафиксированные в Jira acceptance criteria.

Единственное дополнение Michael от себя: рекомендация сделать поле Required без default — это его личная рекомендация поверх спеки, не часть оригинальной спеки.