Skip to content

Commit

Permalink
Additional guidance for creating an abstract
Browse files Browse the repository at this point in the history
Signed-off-by: Michal Maléř <mmaler@redhat.com>
  • Loading branch information
MichalMaler committed Aug 16, 2022
1 parent 03d1bc4 commit c7edb2d
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/main/asciidoc/doc-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down

0 comments on commit c7edb2d

Please sign in to comment.