How I work

I find it best to use these steps:

1. Identify the core functionality.

   • In the case of MUD, this is adding a table and using it in a System ↗.
   • In the case of Optimism, this is deploying a contract ↗.
   • For tevm, this is forking a blockchain and communicating with a product inside the forked blockchain ↗.

2. Write a tutorial that uses the core functionality. Even though the point of the tutorial is to implement the functionality, it needs to be a complete application with observable results. There are two reasons for this:

   • Prove to myself that what I’m writing is accurate, that there are no missing pieces, etc.
   • Provide readers with the psychological payoff of seeing that whatever they did works.

   This is the most important deliverable

   At this point the user has next to zero investment in the product. In the best case scenario, users think it might solve a problem they have. For this reason, the core functionality tutorial has to be as appealing as possible. There are several factors that can help:

   • Be as simple as possible. If it appears that using the product is a hassle, people will just implement their own solution.
   • Solve a problem as quickly as possible, before readers have time to get bored.
   • Be as fun and satisfying as we can make it.

   During this process I typically come across some ideas to improve usability.

3. Based on the tutorial, figure out what reference information is needed. This depends on the way to access the functionality: TypeScript calls, Solidity calls, transactions, etc.

4. Write tutorials about the more advanced features of the product. The decision which advanced features are most important to have tutorials for can come from product mangement, customer support questions, etc.

   These tutorials also need to be complete, show how the feature solves a problem with observable results.