Project Ideas
These are our initial ideas. Technical writers 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:
- Conducting technical research
- Gathering information from SMEs
- Drafting and editing technical tutorials
- Getting reviews and incorporating feedback
- Publishing technical docs
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:
- Workflow
- xadahiya.me/Hydrus-in-detail/
- xadahiya.me/Finishing-up/
- xadahiya.me/Phase2/
- Usage
- Auth
- Example
- Client
Tech writer’s takeaways:
This project will allow you to demonstrate the following technical writing skills:
- Conducting technical research
- Gathering information from SMEs
- Drafting and editing technical tutorials
- Getting reviews and incorporating feedback
- Publishing technical docs
3. Improving the UX of the doc site
Project Description:
The current site design and information architecture can be improved in the following ways:
- Currently, hydraecosystem.org serves as the landing page. But the lack of a sidebar/topbar nav makes it difficult to navigate the content. Implementing a navigation bar would solve this problem.
- The API docs (hydrus submodules) need to be linked from the main site. If time permits, the API docs can be restructured to make them user-friendly.
- The existing pages from different authors can be edited to make the content flow better and appear more homogeneous in the style of writing.
Tech writer’s takeaways:
This project will help you learn and demonstrate your documentation tooling, information architecture, and UX design skills.
Contacts
Technical writers can reach mentors by writing at mentors@hydraecosystem.org and collective@hydraecosystem.org
Join the Development Community. Visit our Slack channel