daviddoji/professional-programming
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a bunch of tech writing resources

Browse Source
This commit is contained in:
Charles-Axel Dein 2023-01-30 13:28:02 -05:00
parent 687584cc11
commit 1c98291e16
No known key found for this signature in database
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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.