Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

5/1/23

Tasks:

  1. Further define Mentees' deliverables
    1. Support Mentee Programs with Documentation
      • Presentation to  new Mentees / Mentors 
    2. Deliverables

      • A set of documentation guidelines and templates that can be used by all Hyperledger projects (Github / Readthe Docs)
      • 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

4/26/23


Personas

4/17/23

List of mentee tasks.

...

Task 2

4/13/23

What is  Task Force Deliverables and Mentee deliverables

5/1/23

4/26/23

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


Determine how Mentee can assist the documentation needs of the below projects

Support Mentee Projects




Recommended common publishing platform depending on user: hyperledger-labs/documentation-template: Template for creating documentation for Hyperledger projects



Recommendations for Best Practice Task Force

What does that look like.

Define AudienceProjects
TOC
SIG Chairs
Meetup


Recommendations

List of deliverables or work products

  •  Common styling guide

  •  Recommended common publishing platform

  •  Document best practices for creating documentation, including information on tooling and the audiences

  •  Create a template repo that new projects can use for creating their documentation


...