Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update a_few_basics.adoc #39

Merged
merged 4 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions src/a_few_basics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,30 @@ Index

NOTE: Settings in the header file (`book_header.adoc` in the docs-templates repo) trigger auto-generation of Appendix prefixes and of the Index (among other things).

=== Lists

Unordered list
* Priv
* Unpriv
* Debug

Ordered list
. Priv
. Unpriv
. Debug

Nested list
* Priv
** Intro
*** Definitions
** CSRs
* Unpriv

Add a title to a list
.Ordered list
. Priv
. Unpriv
. Debug

=== Hyperlinks and cross references

Expand Down
10 changes: 7 additions & 3 deletions src/writing.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
== Write simply and concisely
[[writing-simple]]
== Writing tips

Follow these tips to write your documents well.

=== Write simply and concisely

Keep your writing as simple as possible.

Expand All @@ -11,7 +16,7 @@ Keep your writing as simple as possible.
When you write, keep your international audience in mind.

* Use concepts consistently. Check the glossary for common terms and definitions.
* Avoid words that end in `ing`. Words that end in `ing` can be a verb, adjective, or noun. Rewriting your sentence to avoid `ing` is best. So "Rewrite your sentence to avoid `ing`."
* Avoid words that end in "ing". Words that end in "ing" can be a verb, adjective, or noun. Rewriting your sentence to avoid "ing" is best. So Rewrite your sentence to avoid "ing".

=== Write for accessibility

Expand All @@ -21,7 +26,6 @@ Imagine how your doc sounds with a screen reader. Are your visual elements descr

Use the active voice as much as possible.


When writing for highly technical audiences, strictly adhering to the use of active voice can result in convoluted sentences. As a result, while attempting to use active voice can result in improved clarity, contributors can choose to make use of passive voice. That said, we still encourage RISC-V contributors make use of active voice as much as possible.

Here are some writing guidelines:
Expand Down
Loading