Skip to content

Commit

Permalink
Create style-guidelines.adoc
Browse files Browse the repository at this point in the history
Signed-off-by: Kersten Richter <[email protected]>
  • Loading branch information
kersten1 authored May 7, 2024
1 parent c3eb545 commit bab1c2e
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions src/style-guidelines.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
== RISC-V Style guidelines
[style-guidelines]

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

== 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.

[cols="1,1"]
|===
|Do
|Don't

|In version 1.4, ...
|In the current version, ...

|The Federation feature provides ...
|The new Federation feature provides ...
|===


== 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.

[cols="1,1"]
|===
|Do
|Don't

|Include one command in ...
|Include just one command in ...

|Run the container ...
|Simply run the container ...

|You can remove ...
|You can easily remove ...

|These steps ...
|These simple steps ..
|===



0 comments on commit bab1c2e

Please sign in to comment.