CodeYourFuture / CodeYourFuture/Module-Cloud
[TECH ED] Technical writing 1
- 主要言語
- 言語のデータがありません
- スター
- 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