CodeYourFuture / CodeYourFuture/Module-Cloud

[TECH ED] Technical writing 1

未關閉
#33 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
:brain: Prep work 🎯 Topic Communication 🎯 Topic Structuring Data 🎯 Topic Testing 🏕 Priority Mandatory 🐂 Size Medium 📅 Week 2 Cloud
主要語言
沒有語言資料
星號
0
分支
6
PR 合併指標
30 天內沒有已合併 PR

描述

### Link to the coursework

https://developers.google.com/tech-writing/one

### Why are we doing this?

> Every engineer is also a writer.

This course teaches you the fundamentals of technical writing. Use the principles in this course to write compelling:

- case studies for your portfolio
- READMEs for your projects
- documentation
- tickets, issues, and bug reports
- developer questions

1. complete the linked work
2. revise a piece of technical writing you have already completed using the principles you have just learned
3. ask Chat GPT to compare your original writing and your revision and explain which is better

### Maximum time in hours

2.5

### How to get help

Get help by requesting someone to run the Technical Writing 1 workshop in class or in a midweek session online.

### How to submit

Share ChatGPT's assessment in a thread in Slack

### How to review

ask Chat GPT to compare your writing and your revision and explain which is better

貢獻指南

開啟貢獻指南

研究方向

從連結的 Technical Writing One 課程作業開始,並完成指派的工作。根據課程原則修改一篇先前完成的技術寫作,然後請 ChatGPT 比較原文和修訂稿。將 ChatGPT 的評估作為提交內容分享到 Slack 執行緒中。

由索引模型根據 Issue 內容生成。

評估

領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
描述清楚
新手友好度
55/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。