CodeYourFuture / CodeYourFuture/Module-Cloud
[TECH ED] Technical writing 1
- Linguagem predominante
- Sem dados de linguagem
- Estrelas
- 0
- Forks
- 6
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
### 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
Guia de contribuição
Direção de pesquisa
Comece pelo trabalho do curso Technical Writing One indicado no link e conclua o trabalho atribuído. Revise um texto de redação técnica concluído anteriormente usando os princípios do curso e, em seguida, peça ao ChatGPT que compare o original e a revisão. Compartilhe a avaliação do ChatGPT em um thread do Slack como entrega.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 55/100