RULES FOR WRITING SOFTWARE TUTORIALS

Summary from the TLDR Web Dev newsletter

Effective software tutorials have clear titles and introductions that explain the tutorial's goal and demonstrate the end result. Other recommendations include making code copy-pasteable, using long command-line flags, separating user-defined values from reusable logic, and keeping the code in a working state throughout the tutorial.