Skip to content

Commit

Permalink
Update style-guidelines.adoc
Browse files Browse the repository at this point in the history
fixing the headers

Signed-off-by: Kersten Richter <kersten@riscv.org>
  • Loading branch information
kersten1 authored May 7, 2024
1 parent 5edafdc commit c715d52
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/style-guidelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

All professional technical writers eventually learn to keep their writing as simple as possible.

== Avoid statements that will soon be out of date
=== Avoid statements that will soon be out of date

Avoid words like "currently" and "new." A feature that is new today might not be considered new in a few months.

Expand All @@ -20,7 +20,7 @@ Avoid words like "currently" and "new." A feature that is new today might not be
|===


== Avoid words that assume a specific level of understanding
=== Avoid words that assume a specific level of understanding


Avoid words such as "just", "simply", "easy", "easily", or "simple". These words do not add value.
Expand Down

0 comments on commit c715d52

Please sign in to comment.