Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Technical Writing

Aberta
#6 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 10 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
25/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Domínio
documentation

Direção de pesquisa

Comece pelo curso de redação técnica do Google disponível em developers.google.com/tech-writing/one e revise os objetivos de aprendizagem declarados. O issue não identifica nenhum arquivo do repositório nem nenhuma submissão obrigatória; a conclusão é descrita como fazer o curso e o workshop em sala de aula, sem necessidade de submissão.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

🏝️ Priority Stretch 🐂 Size Medium 📅 Sprint 1 Module-Data-Flows Optional Submit:None
Learning Objectives
  • Plan and author a technical document
  • Edit a technical document for clarity and correctness
Link to the coursework

https://developers.google.com/tech-writing/one

Why are we doing this?

Every engineer is also a writer.

This collection of courses and learning resources aims to improve your technical documentation. Learn how to plan and author technical documents. You can also learn about the role of technical writers at Google.

Take the prep course before class and do the in-class workshop... in class!

Maximum time in hours

2

How to get help

Arrange a mid week study session to work on this course together. Can you invite a native speaker to support you? What skills do you already have in your group? Has someone worked as a writer, teacher, translator, or journalist?

Submission & Review

There is no submission required for this exercise.

Linguagem predominante
JavaScript
Estrelas
0
Forks
276
Métricas de merge de PRs
Nenhum PR com merge em 30d

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de CodeYourFuture/Module-Data-Flows

Todas as issues de CodeYourFuture/Module-Data-Flows

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.