I have determined the approach and goals that need to be accomplished during the project.
Approach
- Analysis of existing Hyperledger docs: Analyze the current Hyperledger documentation in depth and identify the areas that do not provide a clear explanation to new users. These sections would need to be reorganized and updated to ensure clear understanding to the reader and remove any blockers that may not allow new users to use Hyperledger tools.I will also identify any gaps in the documentation that needs to be addressed.
- Create friction logs: Create friction logs to ensure the current documentation is accessible and usable for newcomers.
- Review user feedback: Take feedback and reviews from users and prioritize the areas that need improvement. This can be achieved by surveys in the community and even by interacting with users in community meetings.
- Collaboration with mentor and community members: Being in constant contact with the mentor and other community members to take feedback about the revised content and implement changes based on their suggestions.
- Conduct readability test: Put the updated documentation under the readability test, the common one is the Flesch-Kincaid test. This will help identify areas that need to be revised for better readability.
- Regular reviews and updates: To ensure that the content remains accurate and up to date, I will conduct regular reviews and updates. This includes monitoring any development in the tools and updating the content as necessary.
- Publish updated docs: The final step would be to publish the updated content and write blogs introducing people to the Hyperledger tools and their importance.