Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Project TitleHyperledger Documentation Standards
Status

IN PROGRESS

Primary Focus

CODING DOCUMENTATION  RESEARCH

Project Plan

Week 1: July 3 - July 9

  • Set up group communication channels (mailing list, discord, LinkedIn, etc.)
  • Format Trello Boards for the teams - create a board for each sub-committee in the task force.
  • Prepare a few slides for the welcome onboarding session for mentees.
  • Coordinate and execute presentation for new mentee.
  • Set up teams for the presentation to the Technical Oversight Committee (TOC).
  • Email Min, Mentorship Program Director, about Documentation and Onboarding Task Force plans.
  • Weekly Meeting: Discuss plan for task force moving forward.

Week 2: July 10 - July 16

  • Prepare for the TOC presentation.
  • Weekly Meeting: Review the prepared presentation, get feedback and make necessary adjustments.
  • TOC Presentation: July 11

Week 3: July 17 - July 23

  • Post-TOC presentation: Process feedback from the TOC presentation and adjust the project's direction and objectives as necessary.
  • Begin drafting documentation guidelines and style guide.
  • Weekly Meeting: Discuss progress on guidelines and style guide.

Week 4: July 24 - July 30

  • Finalize documentation guidelines and style guide.
  • Start creating a list of recommended documentation tools and templates.
  • Weekly Meeting: Discuss the finalized guidelines and style guide, and progress on documentation tools and templates.

Week 5: August 1 - August 7

  • Continue developing the list of recommended documentation tools and templates.
  • Start developing a plan for integrating new guidelines and templates into existing Hyperledger projects.
  • Prepare for the Meetup Group presentation.
  • Weekly Meeting: Discuss progress on tools and templates, and the integration plan.
  • TOC Presentation: August

Week 6: August 8 - August 14

  • Meetup Group Presentation: Present the project's progress to the Meetup Group.
  • Continue developing the integration plan.
  • Start drafting a series of blog posts or tutorials on how to use the new guidelines and templates.
  • Weekly Meeting: Process feedback from Meetup Group presentation, discuss progress on the integration plan and blog posts/tutorials.

Week 7 - Week 17: August 15 - November 19

  • Continue working on the integration plan and blog posts/tutorials.
  • Begin the process of integrating the new guidelines and templates into existing Hyperledger projects.
  • Encourage new projects to adopt the new guidelines and templates.
  • Weekly Meetings: Monitor progress, discuss any issues or challenges, adjust plans as necessary.
  • Preparation for Global Forum: Begin preparing for the presentation at the Global Forum. Date is TBD.

End of November

  • Global Forum Presentation: Present the final outcome of the project.
  • Wrap-up: Review project outcomes, process feedback from the Global Forum presentation, plan for future improvements and maintenance.

Note: This project plan is a flexible guide and adjustments can be made as needed to ensure the success of the project.


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

Week 2:

Set up Teams for Presentation to the TOC

Work on TOC presentation\

Discuss plan for task force moving forward.


Week 1: 

Result: Coordinated and excuted presentation to new mentee --excellent Job

Set up Group Communications

Determine best way to communicate with group and set system up , ( mailing list, discord, LinkedIn...) 

Format Trello Boards for the teams.

Create a board for each sub committee in the task force

Create a few slides for the welcome onboarding  session for mentees. 

Create a few slides for review at Mondays Meeting. Include the team in the presentation

Email: Min, Mentorship program Director
You mentioned that you would like 5 minutes or so to talk about the Documentation and Onboarding Task Force that you lead and extend the invitation to the new mentees as an additional ongoing onboarding resource. So if you could provide one or two slides that you will be speaking to so that I can merge into the deck I am working on that would be great.


Documentation Task Force



Documentation Task Force

https://github.com/hyperledger/toc/issues/46

GitHub repo: https://github.com/hyperledger-labs/documentation-template


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

Applicants are encouraged to provide links to previous articles,  open source contributions, such as pull requests or commits to open source repositories. This is not a requirement, but it will help evaluate the applicant's experience as an open source contributor.

Future plans

After the formal mentorship concludes, the project's momentum will be continued by integrating the new guidelines and templates into existing Hyperledger projects and encouraging new projects to adopt them. The guidelines and templates will be reviewed and updated on a regular basis to ensure that they remain relevant and up to date.

Mentor(s) Names and Contact Info

Bobbi Muscara bobbi@ledgeracademy.com




  • No labels