diff --git a/supplementary_style_guide/style_guidelines/links.adoc b/supplementary_style_guide/style_guidelines/links.adoc index 6e2a8922..5faf5a41 100644 --- a/supplementary_style_guide/style_guidelines/links.adoc +++ b/supplementary_style_guide/style_guidelines/links.adoc @@ -2,6 +2,16 @@ [[links]] = Links +[[where-links-are-allowed]] +== Where links are allowed + +To preserve reader focus and improve content usability, inline links are restricted in some places: + +* Concept topics: Avoid inline links. Place essential links in the "Related Links" section at the end of the topic. +* Procedure topics: Inline links are allowed to support task completion. +* Reference topics: Inline links are allowed but consider moving supplemental links to the "Related Links" section when possible. +* Short descriptions: Do not include links. + [[cross-references]] == Cross-references diff --git a/supplementary_style_guide/style_guidelines/structure.adoc b/supplementary_style_guide/style_guidelines/structure.adoc index 49bff3a8..a959610d 100644 --- a/supplementary_style_guide/style_guidelines/structure.adoc +++ b/supplementary_style_guide/style_guidelines/structure.adoc @@ -111,7 +111,7 @@ Short descriptions help readers find the information that they need and confirm * Include user intent. Explain *what* the user must do and *why* they must complete that action. Build upon the title--do not repeat it. * Write for AI and search. High-quality short descriptions are a primary source of metadata for large language models (LLMs) and search engine link previews. A high quality, human-verified summary reduces the risk of AI misinterpretation and saves processing time. -* Do not use DITA-incompatible structures, such as bulleted lists or multiple paragraphs. +* Do not use DITA-incompatible structures, such as bulleted lists, multiple paragraphs, or inline links. === Style guidelines ===