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 2c4ef40 commit 274396c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions _posts/2024-08-09-contributing-to-eclipse-che-docs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ you can do it all in the environment you're already familiar with: an Eclipse Ch

image::/assets/img/contributing-to-eclipse-che-docs/che-docs.png[An Eclipse Che CDE created from the che-docs repository.]


== Getting started

Click the Developer Workspace button in the che-docs repository README file.
Expand Down Expand Up @@ -95,6 +96,7 @@ Here are a few tips that will help you write great technical content:

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].
Expand Down

0 comments on commit 274396c

Please sign in to comment.