CodeYourFuture / CodeYourFuture/Module-Cloud
[TECH ED] Technical writing 1
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 0
- Forks
- 6
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
### 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
Guía de contribución
Línea de trabajo
Comienza con el trabajo del curso Technical Writing One enlazado y completa el trabajo asignado. Revisa un texto de redacción técnica completado anteriormente aplicando los principios del curso y, después, pide a ChatGPT que compare el original y la revisión. Comparte la evaluación de ChatGPT en un hilo de Slack como entrega.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 55/100