IOTA Foundation Is Submitting a Project Proposal For Google Season of Docs
The full article was originally published by Jake Cahill on Medium. Read the full article here.
Documentation is an important part of what we do at the IOTA Foundation. It not only helps our community to get involved in what we’re building, it’s essential for real-world adoption.
Since we launched our documentation portal, we’ve made some great improvements:
- We’ve added new content such as client library workshops with code you can run in the web browser
- We’ve written with translation in mind, making sure that we use global English
- We’ve improved the platform with new features such as message boxes and an extra level of navigation
As our technology improves and our ambitions grow, so do our documentation goals. We have lots of ideas for improving our content, and it would be great to get the open-source community involved.
This is why, this year, we are applying to take part in Google Season of Docs as an organization!
Google Season of Docs is a program that’s run by Google to connect technical writers to open source organizations. During the 3–6 month program, technical writers help to improve an organization’s documentation, and in return, the writers receive a stipend from Google.
If you’re interested in learning more about us and how to get involved, read on.
About the IOTA Foundation
We do this by:
- Empowering individuals to live freely, safely, and securely in a digital world
- Building enterprise-grade, open-source technologies for and with the community
- Growing and connecting our ecosystem across regions and industries
- Developing solutions that deliver sustainable, real-world impact to industry, society and the environment
- Contributing to open and transparent policies, practices and collaborations as well as helping regulators and public institutions to govern novel technologies
As an organization, we are community born and community-driven, and we host over 100 open source software projects.
Meet Our Team
Our team is based in 23 different countries. Most of us work remotely, so technical writers will easily be able to collaborate with us from anywhere in the world.
The following team members will be representing the IOTA Foundation as mentors:
GitHub username: JakeSCahill
Director of Ecosystem
GitHub username: L3wi
We’d like technical writers to tackle the following project idea during this year’s Season of Docs.
The listed tasks were suggested by our team, but we are more than happy to hear suggestions.
If you’d like to get involved, take a look at our project and reach out to us at email@example.com.
Project idea: Improve our developer documentation
An essential part of our mission relies on developers to pick up our technology and build things with it, which is why we built our developer documentation portal.
This year, the IOTA Foundation will be releasing a series of new products and as well some breaking changes to the IOTA protocol. These changes will have a big impact on our existing documentation.
This is a great opportunity for a technical writer to work with us to:
- Review and refactor our information architecture to help users find what they’re looking for.
- Help to design a landing page with key benefits of our technology and entry points for our different users.
- Establish reusable templates and host them on our GitHub repository.
- Look into how we can improve our platform tooling, for example, to better evaluate our content or to enable conditional text and global variables. We’re open to exploring natural language processing, AI, and machine learning techniques in addition to traditional software.
We plan to translate the documentation. Therefore, we also follow the Global English Style Guide by John R. Kohl.
The platform code is in the iotaledger/documentation-platform repository.