Make improvements for clarity, brevity, and to use more idiomatic/natural English

[wongyah]

Thanks for your list. Technical writing is a subject I'm curious to learn more about.

Leaving aside the lint errors, there are a lot of minor issues with language. Numerous improvements could be made for clarity, brevity, and to use more idiomatic/natural English.

Here are just a few examples from the top, with suggestions:

• Replace "Technical writing is an essential skill of" with "Technical writing is the essential skill of" (an→the).
  • Consider replacing "is the essential skill of" with "is about", "focuses on", or similar.
• Replace "unaccessible" with "inaccessible" (all instances).
• Replace "it is listed as a sublist item of the unaccessible one followed by a mark of Country Name in a pair of parentheses" with "it is listed as a subitem followed by the country name in parentheses".
  • Currently, there is only one case in the list where you actually do this, so consider removing the tip entirely and just addressing this inline. E.g., instead of "(China)" use something like "(accessible in China)".
• In the ToC, replace "Text automatic processing" with "Text processing", and "Regular expression" with "Regular expressions".
• Replace "are the best start points" with "are the best starting points".
• Replace "Now, you have known a bit of technical writing 👏!" with "Now you know a bit about technical writing! 👏".
• This is verbose and subjective: "To learn a new skill or a new subject systematically, there is nothing better than 📚 academic textbooks and tutorials self-published by experienced professionals at work. Here you are, enjoy 😄!"
  • Consider something like: "Textbooks and tutorials by experienced professionals are great resources for systematically learning a new skill."
• Consider changing "A technical writer at a computer vision startup confessed his daily work in every detail" to something like "Detailed daily work routine by a technical writer at a computer vision startup".
• Instead of: "Tom Johnson, a senior technical writer at Google and the founder of the popular blog I'd Rather Be Writing, teach you how to write documentation for API step by step".
  • "teach you" → "teaches you".
  • Consider: "How to write API documentation step by step, by Tom Johnson, senior technical writer at Google and founder of the I'd Rather Be Writing blog".

...An so on.

I'd recommend doing another careful editing pass over all of the text, with a focus on being more concise (since this is a list rather than a blog post). That doesn't mean you need to drop your playful/friendly tone!

Originally posted by @slevithan in sindresorhus/awesome#3022 (comment)

[wongyah]

Accepted suggestions

Words

"Inaccessible" vs. "unaccessible"

Replace "unaccessible" with "inaccessible" (all instances).

Replace "it is listed as a sublist item of the unaccessible one followed by a mark of Country Name in a pair of parentheses" with "it is listed as a subitem followed by the country name in parentheses".

Currently, there is only one case in the list where you actually do this, so consider removing the tip entirely and just addressing this inline. E.g., instead of "(China)" use something like "(accessible in China)". ✅

Refer to Unaccessible vs. Inaccessible – Which is Correct?.

"Text processing" vs. "Text automatic processing"

In the ToC, replace "Text automatic processing" with "Text processing", and "Regular expression" with "Regular expressions". ✅

"Starting points" vs. "start points"

Replace "are the best start points" with "are the best starting points". ✅

"A bit" vs. "a bit of"

Replace "Now, you have known a bit of technical writing 👏!" with "Now you know a bit about technical writing! 👏". ✅

Sentences

This is verbose and subjective: "To learn a new skill or a new subject systematically, there is nothing better than 📚 academic textbooks and tutorials self-published by experienced professionals at work. Here you are, enjoy 😄!"

Consider something like: "Textbooks and tutorials by experienced professionals are great resources for systematically learning a new skill." ✅

grammars

Instead of: "Tom Johnson, a senior technical writer at Google and the founder of the popular blog I'd Rather Be Writing, teach you how to write documentation for API step by step".

"teach you" → "teaches you". ✅

Replace "Regular expression" with "Regular expressions". ✅

For discussion

Replace "Technical writing is an essential skill of" with "Technical writing is the essential skill of" (an→the). Consider replacing "is the essential skill of" with "is about", "focuses on", or similar.

Consider changing "A technical writer at a computer vision startup confessed his daily work in every detail" to something like "Detailed daily work routine by a technical writer at a computer vision startup".

Instead of: "Tom Johnson, a senior technical writer at Google and the founder of the popular blog I'd Rather Be Writing, teach you how to write documentation for API step by step".
Consider: "How to write API documentation step by step, by Tom Johnson, senior technical writer at Google and founder of the I'd Rather Be Writing blog".