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 17 Next »

Requirements for BEST PRACTICE BADGE
(Standards are in development).


In April 2018, Kelly Cooper brought the work group the style guide below:

Several months later, I created a condensed version that uses lean/agile principles below:


should be proofread carefully

should use the Hyperledger/Linux Foundation standard colors and slide template

should use minimal text 


Just a few thoughts from Gordon

should contain standard front matter: Title page, About Hyperledger, About This Paper, Contents, Version number and Publication Date, Creative Commons notice, Acknowledgements, About the Working Group sponsor...

should explicitly define the audience, scope and purpose in the front matter

should probably use a numbering system to help organize the contents

should start with an introductory overview of the topics to be covered, and then move into the details of various topics

should use a recognized rhetorical approach when necessary: for example, move-from-the-familiar-to-the-unfamiliar, or compare-and-contrast

should list items in alphabetical order by default; if using any other ordering system, should explicitly state which (by chronology, location, platform, size and so on) 

should contain standard back matter: Conclusions, Appendixes, Further Resources, References

should be prepared in Gdocs, not LaTex nor any other formatting language or system

should not require using Github to avoid unnecessary overhead and version control confusion


  • No labels