Skip to content

Commit

Permalink
che docs contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
deerskindoll committed Aug 7, 2024
1 parent a583661 commit 966e9b7
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion _posts/2024-08-09-contributing-to-eclipse-che-docs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,10 @@ Here are a few tips that will help you write great technical content:
* Keep the focus on the user. Write the content around what the user can achieve when they follow your instructions.
* Keep passive voice to a minimum.

image::/assets/img/pp-hemingway.png["The famous opening lines of Jane Austen's Pride and Prejudice novel don't follow any of the writing tips listed in this blog post. At grade 16, they also have a very high readability score in the Hemingway Editor. Your technical document should have a readability score between grade 9 and 11."]
image::/assets/img/contributing-to-eclipse-che-docs/pp-hemingway.png["The famous opening lines of Jane Austen's Pride and Prejudice novel don't follow any of the writing tips listed in this blog post. At grade 16, they also have a very high readability score in the Hemingway Editor. Your technical document should have a readability score between grade 9 and 11."]

If you want to learn more about technical writing in general,
check out the link:https://developers.google.com/style[Google developer documentation style guide].
The readability test is a part of the link:https://hemingwayapp.com/[Hemingway Editor].

Happy writing!

0 comments on commit 966e9b7

Please sign in to comment.