Versions Compared

Key

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

...

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 six guiding principles and six specific recommendations that intertwine with those guidelines. 

GUIDING PRINCIPLES:

  1. Standardization improves adoption of projects within the Hyperledger Ecosystem
  2. Each project should utilize a standard Location for Documentation: we recommend ReadtheDocs
  3. A common Markup Language and interface would increase standardization 
  4. Templates exist for ReadtheDocs and can be used to improve the look and feel of any ReadtheDocs page
  5. Recognize and Resolve any tension between standardization (common template) with the implicit uniqueness of each Hyperledger project.
  6. Standards should be reflected in a consistent manner such as a badging system or checkmark awarded for adherence to these principles

...