Technical writing

[ninabreznik]

BLOGS

• for each post, create markdown (later we'll publish them on our own blog) and then copy the content to Medium (until we have our blog page ready, we'll post on Medium, later on both)

• find good blog examples in the space

  • https://blog.zeppelin.solutions/
  • https://medium.com/metamask
  • https://blog.ethereum.org/
  • https://medium.com/remix-ide
  • https://blog.datproject.org/
  • https://kauri.io/

• write/select the topics/possible titles we want to cover

  • play updates
    • new features
    • tutorials (5-10 min tutorials - can be just text or combination with screencasts)
    • interesting use cases/demos of our features
      • selected popular source code analysis and links to the code
        • see example https://medium.com/play-project/moloch-is-a-grant-making-dao-guild-and-a-radical-experiment-in-voluntary-incentive-alignment-to-ab195ff38503
  • solidity
    • intro to solidity
      • why is solidity here to stay
      • stats about solidity usage (how many devs, how many contracts etc.)
      • who are important people in solidity space (solidity developers, solidity security specialists etc.)
      • 5 free tools to build Solidity contracts online
    • tips & tricks on how to become a better solidity dev
      • What did I learn in my first year of developing Solidity
      • 9 hacks to optimize your solidity code
      • How to make a Crowdsale contract in 1h
      • How to structure Solidity code
      • 10 handy solidity libraries you should import in your projects
      • How I learned Solidity and how you can too (maybe interview with someone?)
    • verifying solidity source code
      • why are they important
      • how can you verify contracts at this moment
    • auditing smart contracts
      • security in smart contracts
      • security professionals in the space ()

ON THE PAGE

• glossary (dictionary <<< links to it from the blog posts (to explain certain word) )
• FAQ (frequently asked questions <<< list of most common questions about our tool)
  • How do you compile the contract?
  • How do you deploy the contract?
  • How to import a library/other contract in your contract?
  • How to use validations in Play interactive interface (smart contract UI)?
  • How to change the network to which I want to deploy the contract?
  • Why can't I use multiple contracts in one file?
  • Why can't I select the compiler version manually?
  • Where can I find the ABI or a bytecode of the contract?
  • How can I save my source code for the next visit?
  • Which wallets can I use to interact with the Play Editor? (metamask, nifty etc.)

MEMES

• create some nice gifs or memes to spice up our Twitter feed
  • can be some philosophical thoughts/quotes/jokes/code snippet with a punchline

INTERVIEWS

• interviews with VIP in the space on topics we are connected to
• interviews with open source creators who are less visible

OTHER

• what else?