Improve "Update writing-skills" section and add additional resources (#6170)

* Improve "Update writing-skills" section and add additional resources

* Enhanced the explanation of the importance of good writing skills for software developers
* Added three resources for further reading on effective communication and documentation

* Update src/data/roadmaps/devrel/content/writing-skills@0ntOE6PSdMl_EXB9gdgIv.md

---------

Co-authored-by: Kamran Ahmed <kamranahmed.se@gmail.com>
pull/6171/head
Kiko Castro 3 months ago committed by GitHub
parent ae7bff26cc
commit 361cc0bd4f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 8
      src/data/roadmaps/devrel/content/writing-skills@0ntOE6PSdMl_EXB9gdgIv.md

@ -1 +1,9 @@
# Writing Skills
Good writing skills are crucial for software developers because they enhance communication, documentation, and collaboration. Clear and concise writing ensures that complex technical concepts are easily understood by team members, stakeholders, and end-users. Effective documentation, including comments, user manuals, and technical guides, helps maintain code quality and facilitates future maintenance and updates. Writing also plays a key role in crafting clear commit messages, bug reports, and project proposals, which are essential for smooth project management and collaboration. In an increasingly global and remote work environment, the ability to articulate ideas and solutions in writing becomes even more vital, ensuring that everyone is on the same page and can contribute effectively to the project's success.
Learn more from the following resources:
- [@article@Putting Ideas into Words](https://www.paulgraham.com/words.html)
- [@article@Patterns in confusing explanations](https://jvns.ca/blog/confusing-explanations/)
- [@article@Signposting: How to reduce cognitive load for your reader](https://newsletter.weskao.com/p/sign-posting-how-to-reduce-cognitive)

Loading…
Cancel
Save