From c7edb2d1e82f880ef824b78d6d3254ab25693391 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Mal=C3=A9=C5=99?= Date: Tue, 16 Aug 2022 09:36:46 +0200 Subject: [PATCH] Additional guidance for creating an abstract MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michal Maléř --- docs/src/main/asciidoc/doc-reference.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/src/main/asciidoc/doc-reference.adoc b/docs/src/main/asciidoc/doc-reference.adoc index 2e54a4eb7b095..cbd77b52c10e1 100644 --- a/docs/src/main/asciidoc/doc-reference.adoc +++ b/docs/src/main/asciidoc/doc-reference.adoc @@ -117,6 +117,7 @@ Start a new line at the end of each sentence, and split sentences themselves at === Abstracts (preamble) For optimum findability, add a short description using user-oriented keywords to summarize the document's purpose, task, and intent in no more than three sentences. +Good abstracts also mention the benefits of following this content and avoid filler words, such as: "This document..", "This tutorial..", and "The following.." [IMPORTANT] ====