Skip to content

good_docs.md #2835

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 19, 2025
Merged

good_docs.md #2835

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/rocky_insights/blogs/good_docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ contributors: Steven Spencer

## Introduction

Translator's provide valuable insight into writing clear, concise, documentation. They know what does not translate well and what confuses a reader better than most. This document examines some of those issues and highlights best-practices for document creation.
Translators provide valuable insight into writing clear, concise documentation. They know what does not translate well and what confuses a reader better than most. This document examines some of those issues and highlights best practices for document creation.

### From the author

Expand Down Expand Up @@ -49,7 +49,7 @@ Example:

Note: If you want to use acronyms, always define them the first time: “Customer Relationship Management (CRM) system”.

By eliminating idioms and unnecessary jargon, the meaning of your document becomes more clear. Replacing contractions with the words they represent, means that translation efforts in all languages are easier. Your document is the most understandable to the reader when you replace or define acronyms.
By eliminating idioms and unnecessary jargon, the meaning of your document becomes clearer. Replacing contractions with the words they represent, means that translation efforts in all languages are easier. Your document is the most understandable to the reader when you replace or define acronyms.

## Use active voice

Expand Down