news.volyx.in

How I, a non-developer, read the tutorial you, a developer, wrote for me (anniemueller.com)

931 points by wonger_ · 308 days ago · 444 comments on HN

Article summary

The article is a satirical take on how developers write tutorials, from the perspective of a non-developer trying to follow a tutorial written by a developer. The tutorial is filled with technical jargon and complex steps, making it difficult for a beginner to understand. The author pokes fun at the way developers often write documentation, assuming a level of prior knowledge that not everyone possesses. The article highlights the need for clearer and more accessible documentation.

Main themes

  • Technical documentation
  • Developer communication
  • Beginner-friendly tutorials
  • Programming languages
  • Education and learning

What commenters say

  • Most tutorials are not written with non-developers in mind, but rather for other developers who are already familiar with the ecosystem.
  • Developers often prioritize brevity and conciseness in their documentation, which can make it difficult for beginners to understand.
  • Some argue that access modifiers and other complex concepts are not necessary for beginners to learn, and that simpler languages like Java or Python are more suitable for introductory programming courses.
  • Others believe that Java is a dying language and that Python or other languages are more suitable for teaching algorithmic thinking and programming concepts.
  • The use of install scripts and automated tools can simplify the installation process, but may not provide the necessary context and understanding for beginners.
  • Clear and thorough documentation is essential for helping beginners learn and understand complex technical concepts.
  • The education system often lags behind industry trends, and programming languages and curricula may not be up-to-date or relevant to current industry needs.
  • Some developers believe that certain programming languages, such as C# or Kotlin, are more suitable for beginners due to their simplicity and ease of use.