Uploaded image for project: 'Debezium'
  1. Debezium
  2. DBZ-9130 Prepare AsciiDoc files for migration to DITA
  3. DBZ-9677

Add short description introductory sentences to each topic module

XMLWordPrintable

    • Icon: Sub-task Sub-task
    • Resolution: Unresolved
    • Icon: Major Major
    • Backlog
    • None
    • documentation
    • None
    • 5
    • False
    • Hide

      None

      Show
      None
    • False

      In each upstream file, wherever a content chunk is designated as a topic (concept, procedure, reference), insert a short description. Short descriptions describe the purpose or theme of the topic module.
      It’s the first paragraph in a procedure, concept, reference module, or assembly.

      The short description should be a single, concise paragraph containing one or two sentences between 50 and 300 characters long. 300 characters is between 42 and 75 words.

      Good short descriptions are essential in an AI- and search-based world:

      • They are used as a link preview and a blurb in search results.
      • They explain the WHAT and the WHY. They help readers find the information that they need and help them confirm that they are in the right place.
      • AI uses the short description as a primary source of metadata. When a user submits a query to an AI-powered search tool or chatbot, the AI scans this metadata.

      Apply the following guidelines when creating short descriptions:

      • Do not use sentence fragments. Use complete sentences.
      • Focus on user intent.
      • Avoid self-referential language, such as "This topic covers…​" or "Use this procedure to…​".
      • Avoid feature-focused language. Focus on what users can accomplish with a product, not on what a product does. For example, avoid phrases such as "This product allows you to…​".
      • Use customer-centric language, such as "You can…​ by…​" or "To…​, configure…​".

      Each short description in the AsciiDoc source must be preceded by the attribute [role="_abstract"]

              broldan@redhat.com Robert Roldan
              broldan@redhat.com Robert Roldan
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: