...
- Best Practices: Categorize best practices based on specific domains or categories.
- Improving User Experience: Implement friction logs and incorporate visual elements (diagrams, screenshots, etc.) to enhance accessibility and usability for users.
- Enhanced Query Review/Feedback Mechanism: Streamline and enhance the query/feedback management process on Discord to better support and address questions and inquiries raised by contributors.
- Enable Discussions: Facilitate collaborative discussions and engagement by leveraging GitHub's Discussions feature.
A few References
- The Mayfield Handbook of Technical Scientific Writing (Authored by Leslie C. Perelman, James Paradis, Edward Barrett)
- Technical Documentation in Software Development: Types, Best Practices, and Tools
- Docs for Developers — An Engineer's Field Guide to Technical Writing (By Jared Bhatti, Zachary Sarah Corliessen, Jen Lambourne, David Nunez, & Heidi Waterhouse)
- The Documentation System (by Divio)
By incorporating these visual elements, interactive examples, collaboration avenues, and a feedback mechanism, you can greatly enhance the user experience and make the Hyperledger documentation more engaging and useful for users. Additionally, the suggested resources and references will provide valuable guidance for improving the documentation process.
...