...
This document is representative of a fact finding mission with generalized principles and specific 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. Then, this document presents concrete examples that elucidate our principles and guidelines.
Our ultimate goal with this taskforce is mean to foster open discussion and create a place for new ideas on consistency and standardization for the betterment of the entire Hyperledger project documentationecosystem.
8 GUIDING PRINCIPLES:
- Standardization improves the speed and ease of adoption of multiple projects within the Hyperledger Ecosystem
- Each project should utilize a similar hosting platform for Documentation for ease of use and learnability
- 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
- While we recognize the implicit uniqueness of each Hyperledger project, most companies have a standard theme for product pages
- Standards should be reflected in a consistent manner through a badging system or checkmark awarded for adherence to these principles
- Allow for community involvement to avoid a strictly top-down approach; instead, reflect the values of the open-source community
...