CodeYourFuture / CodeYourFuture/Module-Cloud
[TECH ED] Technical writing 1
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 0
- Fork
- 6
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
### 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
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia con il lavoro del corso Technical Writing One collegato e completa il lavoro assegnato. Rivedi un testo di scrittura tecnica completato in precedenza applicando i principi del corso, poi chiedi a ChatGPT di confrontare l’originale e la revisione. Condividi la valutazione di ChatGPT in un thread Slack come consegna.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 55/100