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.

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

Docs: Creating an onboarding Guide for technical and content writers #701

Open
4 of 13 tasks
CynthiaPeter opened this issue Jun 26, 2023 · 7 comments
Open
4 of 13 tasks

Comments

@CynthiaPeter
Copy link
Contributor

CynthiaPeter commented Jun 26, 2023

What Docs changes are you proposing?

An onboarding resource for technical and content writers in the Igbo API community. This onboarding document will highlight tips and essential information that introduces new contributors to the community and projects within.

The Onboarding guide will highlight or link to existing resources things like:

  • What the community is about ( Product, purpose, goals).
  • Organization structure.
  • General meetings - Content-specific meetings.
  • Definition of goals for the tech writing and content team.
  • User and community engagement channels (forums, chat rooms)
  • Where to find specific information.
  • Content structure and content buckets.
  • Github (Feature branches, conventional commits, naming branches, creating issues for docs, and all things Git).
  • Glossary | Style Guide | Use of terms (Long term)

Why do we need this?

  • To help new contributors get comfortable with the "What, Why, How, Who" questions they may have.
  • To have one source of truth for writers and editors in the community.

Next steps?

I'll need your assistance with this @ijemmao.

  • Create an issue template for Docs to add issues specific to documentation while we work through onboarding tasks. I have created a template here.
  • Create a notion board on the Nkọwa okwu Community Projects named Technical & Content Writing onboarding. Edit and Add this JD to this doc.
  • Add a volunteer form for new technical and Content writing volunteers here.
  • Add 'Technical or Content Writer' to volunteer positions in the volunteer form.

Please comment here or on the #docsfeedback slack if you have any questions or concerns. Thanks

Additional Notes

  • This will be an ongoing project and will be improved as we go.
  • This issue will be a conversation tracker, including the slack #docsfeedback channel.
@ijemmao
Copy link
Collaborator

ijemmao commented Jun 26, 2023

@CynthiaPeter thank you so much for this super comprehensive task list 😘

@CynthiaPeter
Copy link
Contributor Author

Thank you, Ijemma.

I received all the notifications.

Next steps:

  • I'll get the interested technical writers onboard. First, they'll read through the volunteers' page, and then we'll have a call and work on the onboarding resource together. It'll help us kick the team off.
  • I'll let you know if we need your help.

@pauluzo
Copy link

pauluzo commented Jun 27, 2023

Hello @CynthiaPeter @ijemmao I'd be interested in technical writing for this

@CynthiaPeter
Copy link
Contributor Author

@pauluzo, That's good to know.

If you're on Slack, join the #docs-feedback channel and we can schedule a call and start working on it together. If that's ok?

@pauluzo
Copy link

pauluzo commented Jun 30, 2023

@CynthiaPeter thanks. I'm not on the slack group for this project, yet. Hopefully @ijemmao can help with that.

@CynthiaPeter
Copy link
Contributor Author

@pauluzo you can start here: nkowaokwu.com/volunteer.

Let me know if you need any more information.

@CynthiaPeter
Copy link
Contributor Author

@pauluzo, have you been able to join the slack channel? I'll like you to start with this when you have time, please join slack and let's start working on this. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants