Technical Writing
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the linked Google technical writing course at developers.google.com/tech-writing/one and review the stated learning objectives. The issue identifies no repository file or required submission; completion is described as taking the course and in-class workshop, with no submission required.
Written by the indexing model from the issue text.
Description
Learning Objectives
- Plan and author a technical document
- Edit a technical document for clarity and correctness
Link to the coursework
https://developers.google.com/tech-writing/one
Why are we doing this?
Every engineer is also a writer.
This collection of courses and learning resources aims to improve your technical documentation. Learn how to plan and author technical documents. You can also learn about the role of technical writers at Google.
Take the prep course before class and do the in-class workshop... in class!
Maximum time in hours
2
How to get help
Arrange a mid week study session to work on this course together. Can you invite a native speaker to support you? What skills do you already have in your group? Has someone worked as a writer, teacher, translator, or journalist?
Submission & Review
There is no submission required for this exercise.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 276
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from CodeYourFuture/Module-Data-Flows
-
🏕 Priority Mandatory 📅 Sprint 3 Core Module-Data-Flows Submit:None 🦔 Size Tiny
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
🏕 Priority Mandatory 🐇 Size Small 📅 Sprint 2 Core Module-Data-Flows Submit:None
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
🏕 Priority Mandatory 🐂 Size Medium 📅 Sprint 3 Core Module-Data-Flows Submit:None
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
-
🏕 Priority Mandatory 🐂 Size Medium 📅 Sprint 2 Core Module-Data-Flows Submit:None
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
-
🏕 Priority Mandatory 🐂 Size Medium 📅 Sprint 1 Core Module-Data-Flows Submit:None
Difficulty 1/5 1-3 hours Newbie friendliness 35/100
All issues in CodeYourFuture/Module-Data-Flows
Similar issues
-
ai-observability bug team/ai-observability
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
AllTheMods/ATM-10-L#19 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
SignalK/n2k-signalk#345 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
JuliaPluto/PlutoPlotly.jl#72 ·