Add a bunch of tech writing resources
This commit is contained in:
parent
687584cc11
commit
1c98291e16
13
README.md
13
README.md
|
@ -1652,6 +1652,19 @@ More specific topics:
|
||||||
- [Patterns in confusing explanations](https://jvns.ca/blog/confusing-explanations/), Julia Evans
|
- [Patterns in confusing explanations](https://jvns.ca/blog/confusing-explanations/), Julia Evans
|
||||||
- [Technical Writing for Developers](https://css-tricks.com/technical-writing-for-developers/)
|
- [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)
|
![Write like an Amazonian](./images/amazon_writing_rules.jpeg)
|
||||||
|
|
||||||
> If you’re overthinking, write. If you’re underthinking, read.
|
> If you’re overthinking, write. If you’re underthinking, read.
|
||||||
|
|
Loading…
Reference in New Issue