Skip to content

Commit

Permalink
Update writing.adoc
Browse files Browse the repository at this point in the history
Signed-off-by: Kersten Richter <kersten@riscv.org>
  • Loading branch information
kersten1 authored Aug 1, 2024
1 parent fefe93f commit 28f02b1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/writing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ Use simple and direct language. Avoid using unnecessary phrases, such as saying
|In the preceding output, we can see
|===

An exception to this rule is the rationale sections.

=== Avoid Latin phrases

Prefer English terms over Latin abbreviations.
Expand Down Expand Up @@ -125,7 +127,7 @@ Avoid making promises or giving hints about the future. If you need to talk abou
an alpha feature, put the text under a heading that identifies it as alpha
information.

An exception to this rule is documentation about announced deprecations targeting removal in future versions.
An exception to this rule is documentation about announced deprecations targeting removal in future versions.

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

Expand Down

0 comments on commit 28f02b1

Please sign in to comment.