Versions Compared

Key

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

Please Copy and Use this template when developing a White paper for Hyperledger. Google doc White paper Template


Here is a copy of the HYPERLEDGER WHITE PAPER


Steps to follow when a SIG (or WG too?) is working on writing a whitepaper.

  •  Send group whitepaper template to use as a starting point
  •  Review and copy edit before publishing
  •  Post on Publications page
  •  Plan social media posts
  •  Create home page banner
  •  Invite Chair to TSC call to discuss (if paper is technical)
  •  Announce whitepaper (and TSC discussion if one is happening) on MC call

Contributed by Gordon Graham 4-8-2019

...

[When the white paper is prepared for publication, the designer can recreate the graphic to look nicer and use the Linux Foundation color scheme.]





Image AddedImage Removed

FIGURE 1: THE HYPERLEDGER GREENHOUSE STRUCTURE

...

[Although GDocs can’t do Endnotes, the designer will move all your footnotes here. In every footnote, provide the AUTHOR(s), the article or document TITLE, the PUBLISHER, the DATE, and if you have it, the PAGE NUMBER. For a website, include the URL and RETRIEVED ON DATE.]




comments:

White Paper Template

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

Webinar