Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 56 Next »

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.

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 
  • Github or Gerrit repositories 
  • Graphic Set
  • Whitepaper
  • Training Documentation Packet
  • Diverse group of Maintainers

Templates Resource Checklist:



On-the-fly Style Guide for Hyperledger Publications

Hyperledger Style Guide for Publications

  • Last updated September 23, 2019 

“I put together this style guide on-the-fly while working on publications for Hyperledger. When I encounter an inconsistency or a questionable term, I decide which way seems to make the most sense. I personally dislike the Chicago Manual of Style because it so often says ‘either approach is acceptable.’ I’m not saying these decisions are perfect and must stand forever, but I have followed these guidelines in the first four or five white papers I’ve revised and in several case studies I’ve written over the past year.”Gordon

White Paper Standards

USE CASES STANDARDS


COURSES AND ED X CHAPTER GUIDELINES


GITHUB BASICS


GRAPHIC SET STANDARDS


WEBINAR STANDARDS


Creating a Template


CII Best Practices


INSTRUCTOR LED TRAINING FORMATS
PRESENTATIONS GUIDELINES
RFP Standard Documentation

SELF PACED TRAINING FORMATS


 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.

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






  • No labels