Added missing tag in all templates-[role=_abstract]

[dubewarsagar]

This tag is currently missing in the templates.

[abhatt-rh]

Hi @dubewarsagar,
Though @emmurphy1 might have already informed you, I am noting this here for visibility:
This PR will will be on hold until we have more clarity from the migration team on the subject of abstract/short description. Thank you!

[IngridT1]

According to @jhradilek, we'll need that tag for migration.

[jhradilek]

First of all, thank you @dubewarsagar for working on this and @IngridT1 for tagging me here.

This paragraph is the assembly introduction. It explains what the user will accomplish by working through the modules in the assembly and sets the context for the user story the assembly is based on.

I'll leave the review or the decision when you merge this on you before you do, I would recommend reviewing the language to ensure there is a clear distinction between the single paragraph intended to be used as a short description and the rest of the introduction for an assembly or a module. I don't want writers to think that they are limited to just one paragraph of text for the entire introduction, or that all paragraphs that follow will be used for the short description.

I provided a more in-depth explanation of how this works in one of the issues reported to me.

[IngridT1]

As @jhradilek just stated, we do need to re-add [role=_abstract] to the templates. I would recommend also changing the text in each template under the abstract tag to more explicitly state what goes in that short description. I'm happy to work with the appropriate people to change the language.

For example, we could add the language from this DITA resource for each topic type. This is for a procedure:

The short description should explain what the task information helps users accomplish, the benefits of the task, or the purpose of the task. Do not simply repeat the title. Try to include information that will help users understand when the task is appropriate or why the task is necessary. Avoid stating the obvious, such as “You can use XYZ to do A” as the only statement in the short description for Task A. In some cases, add more information about why the task is beneficial.

Do not use sentence fragments. Use complete sentences. Avoid starting short descriptions with phrases such as “This topic describes . . . .” or “This topic is about . . . .”

--
You might think this is unnecessary and already in the SSG, but our short descriptions typically do not follow these guidelines.

[neal-timpe]

@IngridT1 I agree the update to the template to update short description guidance is necessary. Should it be in this PR, or can we create another to contain that work?

[IngridT1]

A new PR is fine, @neal-timpe