CodeYourFuture / CodeYourFuture/Module-Cloud

[TECH ED] Technical Writing 2

Offen
#34 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
🏕 Priority Mandatory 🐂 Size Medium 📅 Week 3 Cloud
Vorherrschende Sprache
Keine Sprachdaten
Sterne
0
Forks
6
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### Link to the coursework
https://developers.google.com/tech-writing/two

### Why are we doing this?
> Every engineer is also a writer.

You must have completed Technical Writing One before doing this work. #33

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 2 workshop](https://developers.google.com/tech-writing/for-instructors) in class or in a midweek session online. Ask in Slack.

### 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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit dem verlinkten Kurs „Google Technical Writing Two“, nachdem du Technical Writing One (#33) abgeschlossen hast. Überarbeite ein bestehendes technisches Schriftstück anhand der Kursprinzipien und bitte anschließend ChatGPT, das Original und die Überarbeitung zu vergleichen. Teile die Bewertung in einem Slack-Thread und bitte dort um Hilfe oder Unterstützung bei einem Workshop.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
50/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.