Docs: Additional guidance for creating an abstract #27302
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Michal Maléř <[email protected]>
michelle-purcell
approved these changes
Aug 16, 2022
|
@gsmet Hello Guillaume, can we ask you for merge when you are done with your review? |
ebullient
approved these changes
Aug 16, 2022
MichalMaler
deleted the
qdocs-50-additional-guidance-for-creating-an-abstract
branch
inoxx03
reviewed
Aug 16, 2022
| @@ -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.." | |||
There was a problem hiding this comment.
This is a good addition:)
I have 3 suggestions:
- Please consider splitting this sentence into 2 shorter ones.
- If you choose to follow the first recommendation, I suggest you swap the order of the 2nd and 3rd sentences (see example at the end of my comment.)
- The use of the phrase this content is a bit ambiguous, because it might not be apparent what this is referring to. You might want to rephrase your sentence a little. For example:
Avoid self referential expressions and filler words, such as "This document..", "This tutorial..", and "The following.."
You should also mention what benefits users gain from reading the content that you are introducing.
Otherwise, LGTM! Nice work!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a contributor to the Quarkus community project, I'd like to know how to write a good extract that helps Quarkus readers to find, skim and understand our content and uses best practices for search engine optimization.