From 1c98291e1668ad1f8c2cda49d863162887acefbb Mon Sep 17 00:00:00 2001 From: Charles-Axel Dein <120501+charlax@users.noreply.github.com> Date: Mon, 30 Jan 2023 13:28:02 -0500 Subject: [PATCH] Add a bunch of tech writing resources --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e9a2e7c..fc0c938 100644 --- a/README.md +++ b/README.md @@ -1652,6 +1652,19 @@ More specific topics: - [Patterns in confusing explanations](https://jvns.ca/blog/confusing-explanations/), Julia Evans - [Technical Writing for Developers](https://css-tricks.com/technical-writing-for-developers/) +Guides & classes about technical writing: + +- [Documentation Guide — Write the Docs](https://www.writethedocs.org/guide/) + - Principles + - Style guides + - Docs as code + - Markup languages + - Tools +- [Technical Writing One introduction](https://developers.google.com/tech-writing/one), Google + - Grammar + - Active voice + - Clear & short sentences + ![Write like an Amazonian](./images/amazon_writing_rules.jpeg) > If you’re overthinking, write. If you’re underthinking, read.