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 6, 2024
1 parent a1504ff commit a583661
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 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,7 +93,7 @@ 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 doesn'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/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].
Expand Down

0 comments on commit a583661

Please sign in to comment.