...
| Page Properties | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Description
To establish consistent and comprehensive documentation standards for the Hyperledger Foundation open-source blockchain platforms. Our goal is to provide developers, users, and other stakeholders with high-quality technical documentation that is accurate, accessible, and easy to understand. Our end goal is to ensure that the technical documentation for the Hyperledger community is of the highest quality, making it easier for developers to build on these platforms and for users to understand and utilize them effectively.
Additional Information** Working Group Pages :
Mentee
Documentation Task Force
https://github.com/hyperledger/toc/issues/46
GitHub repo: https://github.com/hyperledger-archiveslabs/documentation-guidelinestemplate
Learning Objectives
Learning Objectives
- Develop an understanding of best practices for creating open source documentation
- Learn how to collaborate with a community to develop documentation guidelines and templates
- Gain experience in technical writing and editing
- Learn how to use documentation tools and templates
Expected Outcome
Expected Outcome
- A set of documentation guidelines and templates that can be used by all Hyperledger projects
- A style guide for Hyperledger documentation
- A list of recommended documentation tools and templates
- A plan for integrating the new guidelines and templates into existing Hyperledger projects
- A series of blog posts or tutorials on how to use the new guidelines and templates
Relation to Hyperledger
This mentorship project is related to all Hyperledger projects and will provide a consistent set of guidelines and templates that can be used by all projects.
Mentee Skills
Mentee Skills
- Strong written and verbal communication skills
- Experience with technical writing and editing (github)
- Familiarity with open source documentation tools and templates
- Knowledge of Hyperledger and blockchain technology is a plus but not required
Mentee Open Source Contribution Experience
...