Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[TECH ED] Technical writing 1 #33

Open
SallyMcGrath opened this issue Apr 22, 2024 · 0 comments
Open

[TECH ED] Technical writing 1 #33

SallyMcGrath opened this issue Apr 22, 2024 · 0 comments
Labels
🧠 Prep work Prep material to be completed before Saturday's session Cloud 🏕 Priority Mandatory This work is expected 🐂 Size Medium 1-4 hours 🎯 Topic Communication Reading, writing, speaking, and listening in English; expressing our ideas 🎯 Topic Structuring Data Describing, organising, and systematising data 🎯 Topic Testing It's important that software works and that people can use it 📅 Week 2

Comments

@SallyMcGrath
Copy link
Member

SallyMcGrath commented Apr 22, 2024 •
edited
Loading

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
@SallyMcGrath SallyMcGrath added 🏕 Priority Mandatory This work is expected 🐂 Size Medium 1-4 hours labels Apr 22, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Module Cloud Apr 22, 2024
@SallyMcGrath SallyMcGrath changed the title [TECH ED] Technical writing 101 [TECH ED] Technical writing 1 Apr 22, 2024
@SallyMcGrath SallyMcGrath added 🧠 Prep work Prep material to be completed before Saturday's session 🎯 Topic Communication Reading, writing, speaking, and listening in English; expressing our ideas 🎯 Topic Structuring Data Describing, organising, and systematising data 🎯 Topic Testing It's important that software works and that people can use it 📅 Week 2 labels Apr 22, 2024
@SallyMcGrath SallyMcGrath mentioned this issue Apr 22, 2024
Open
5 tasks
@kfklein15 kfklein15 added the Cloud label May 3, 2024
@Farnooshmo Farnooshmo mentioned this issue May 28, 2024
Open
@OlenaReukova OlenaReukova mentioned this issue May 30, 2024
Open
@SallyMcGrath SallyMcGrath mentioned this issue Dec 18, 2024
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🧠 Prep work Prep material to be completed before Saturday's session Cloud 🏕 Priority Mandatory This work is expected 🐂 Size Medium 1-4 hours 🎯 Topic Communication Reading, writing, speaking, and listening in English; expressing our ideas 🎯 Topic Structuring Data Describing, organising, and systematising data 🎯 Topic Testing It's important that software works and that people can use it 📅 Week 2
Projects
Module Cloud
Status: 📋 Backlog
Milestone
No milestone
Development

No branches or pull requests
2 participants
@SallyMcGrath @kfklein15