Welcome to the Task Force

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

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

GUIDING PRINCIPLES:

1. Standardization - Hyperledger Brand recognition
2. Similar hosting platform for Documentation 
3. Leverage

Introduction, Principles & Recommendations 

INTRODUCTION:

Our taskforce goal is to find gaps and opportunities in existing Hyperledger Documentation. Herein, we present conclusions and determine some recommendations. This Review focuses on a comparison of a variety of documentation for the Hyperledger projects, as a case study indicative of how all documentation pages might be standardized.

This document is representative of a fact finding mission with generalized conclusions. These conclusions should be discussed, edited and converted into direct action items. The purpose for this tone is to recognize that each Hyperledger project has a different team, with different maintainers who create and update documentation pages.

Our taskforce is mean to foster open discussion and create a place for new ideas on the betterment of Hyperledger project documentation. Thus we would like to begin with eight guiding principles and eight specific recommendations that intertwine with those guidelines. 

8 GUIDING PRINCIPLES:

1. Standardization improves the speed and ease of adoption of multiple projects within the Hyperledger Ecosystem
2. Each project should utilize a similar hosting platform for Documentation for ease of use and learnability 
3. Any documentation hosting platform used should leverage a common Markdown Language, theme and interface. A simpler design aesthetic is more desirable than a complex page given the goal of standardizing multiple pages within the Hyperledger Ecosystem. If an updated template is used, each project should emulate a newer, web3 aesthetic / open-source community visual layout
4. While we recognize the implicit uniqueness of each Hyperledger project, most companies have a standard theme for product pages 
5. Standards should be reflected in a consistent manner such as a A badging system or checkmark awarded for adherence to these principlesAllow for community involvement to avoid a strictly top-down approach; instead, reflect the values of the open-source community for applying Standards

8 SPECIFIC RECOMMENDATIONS: 

1. All Hyperledger projects should utilize ReadTheDocs for documentation hosting 
2. Standardize documentation content to promote increased usage and project adoption 
3. Re-factor any existing inconsistencies in style, graphics, tables, bullet points, readability, links, and content usefulness for all projects 
4. Current / Future Hyperledger Projects should both utilize the a standardized and agreed upon documentation pattern
5. The Fabric documentation pattern could serve as a template: ReadtheDocs for documentation, GitHub for all code truth, and a Hyperledger Wiki page for Community items and badging. 
6. Standardize graphics and the glossary section for better concept lookups and user experience. 
7. All Projects can leverage Discord: include or “pin” documentation relevant posts. (currently all are not pinned) 
8. Utilize a survey to reflect the voice of the various unique projects that have documentation pages in disparate themes with varying styles and layouts. 

Tasks to be completed

...

• Determine The Current Status of all Projects/Tools/Libraries

...

• Examine the current process used for documentation

...

• Create Standards / Best Practices for the Community

...

• Create Documentation Best Practice badging system.

...

List of deliverables or work products

...