Project Ideas

These are our initial ideas, students can create their proposals by combining these ideas and/or adding their own. New ideas always welcome!

1. Writing the conceptual and architectural overviews for the project

Project Description:

Currently, the conceptual and architectural overview of the project is scattered across the following documents/articles:

We need to refactor the existing information to provide a conceptual and architectural overview of the project. The overview needs to be user-friendly and (as far as possible) jargon-free and should include real-world use-cases of the project.

Tech writer’s takeaways:

This project will allow you to demonstrate the following technical writing skills:

2. Creating a “Get Involved” document

Project Description:

As the project evolves through the pre-alpha and alpha phases, we would like to generate interest among developers/users for the purpose of testing initially and eventually adoption. We need a guide to help contributors set up the testing environment and know what workflows/use-cases to test. This guide could also include contribution guidelines (how to open issues, whom to assign issues to, how to open PRs, and so on). The information in the following documents can be used to create this guide:

Tech writer’s takeaways:

This project will allow you to demonstrate the following technical writing skills:

3. Improving the UX of the doc site

Project Description:

The current site design and information architecture can be improved in the following ways:

Tech writer’s takeaways:

This project will help you learn and demonstrate your documentation tooling, information architecture, and UX design skills.

Contacts

Students can reach mentors by writing at hydra-ecosystem-documentation[snail-here]googlegroups.com

Join the Development Community: Gitter chat