Page tree

Versions Compared

Key

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

CII Best Practices


COURSES AND ED X CHAPTER GUIDELINES


Creating a Template


GITHUB BASICS


GRAPHIC SET STANDARDS


INSTRUCTOR LED TRAINING FORMATS


PRESENTATIONS GUIDELINES


RFP Standard Documentation


SELF PACED TRAINING FORMATS


USE CASES STANDARDS


WEBINAR STANDARDS


Whitepaper Standards


 Developing Standards AND COLLECT CURRENT DOCUMENTATION 

To exit incubation, as project must have Sufficient user documentation
The project must including enough documentation for anyone to test or deploy any of the modules.

     
 BEST PRACTICE BADGE

Online User Guides

White Paper
On Line Course

Getting StartedUser Guides

Graphic Set:

Webinars

Self Paced Training

Instructor Led Training

Code on

Github 

MOOC

Section
EDX Chapter

Presentations:

Technical /
Non-technical

Use Cases

Fabrichttps://hyperledger-fabric.readthedocs.io/en/latest/https://hyperledger-fabric.readthedocs.io/en/latest/architecture.htmlhttps://hyperledger-fabric.readthedocs.io/en/latest/whatis.htmlhttps://hyperledger-fabric.readthedocs.io/en/latest/ops_guide.html

·         

·         

https://hyperledger-fabric.readthedocs.io/en/latest/tutorials.html    


https://github.com/hyperledger/fabric

https://openblockchain.readthedocs.io/en/latest/biz/usecases/
Sawtoothhttps://sawtooth.hyperledger.org/docs/

·         



·         

·         

·         






BurrowDocumentation In Progress:  https://github.com/LedgerAcademy/burrow/blob/develop/README.md




·         

·         

·         


https://github.com/hyperledger/burrow


Indy https://indy.readthedocs.io/en/latest/

·         



·         

·         

·         






Irohahttps://iroha.readthedocs.io/en/latest/

·         



·         

·         

·         






UrsaUrsa Library Motivation

·         



·         

·         

·         






AriesDocumentation Unavailable

·         



·         

·         

·         






TransactDocumentation Unavailable

·         



·         

·         

·         






Composerhttps://hyperledger.github.io/composer/latest/introduction/introduction.html










Cellohttps://cello.readthedocs.io/en/latest/










Caliperhttps://cello.readthedocs.io/en/latest/










QuiltDocumentation Unavailable










Gridhttps://grid.hyperledger.org/docs/






https://github.com/hyperledger/grid


ExplorerDocumentation Unavailable










Requirements for BEST PRACTICE BADGE :

Best practices 

  • All project names must be prefaced with “Hyperledger.”
  • Ensure the name is uniquely identifiable. Anticipate and remove potential confusion.
    • Are there closely named brands in the tech industry or elsewhere?
    • Is it similar to popular existing open source projects?
    • Is your project also a common word? If it’s too generic, searching for it and enforcing trademark compliance may be difficult.
  • The name should give people some understanding of what the technology does and/or how people can use it.
  • Who does your project most appeal to? Understand your target user and what kind of names or brands they respond to.
  • Think carefully about what the name evokes. It sets the tone and intent, and will ideally inspire action.
  • Consider incorporating a thematic mascot (e.g., Ursa’s bear, Aries’ ram, Burrow’s marmot).
  • Aim for no more than eight characters so it will be quick to type and the logo won’t take up too much space.
  • Think inclusively.
    • Avoid complex acronyms and unnecessarily technical terminology/jargon. How will the name will translate to other cultures or people that may join the project in the future?
    • If you select a name related to an inside joke, make sure the origin story is one you’re willing to share with the masses as part of the brand narrative.
    • Make sure the name is easy to remember and easy to pronounce. Consider potential mispronunciations.

Project Checklist

  •  Wiki space Maintenance 
  •  Repositories 
  •  Github or Gerrit repositories 
  •  Graphic Set
  •  Whitepaper
  •  Training Documentation Packet
  •  Mooc 
  •  Webinars



Software documentation types