Rules for Writing Software Tutorials
refactoringenglish.com
It's easier than you think to write an exceptional software tutorial. You can stand out in a sea of mediocre guides by following a few simple rules.
  • dajoho@sh.itjust.works
    112·
    4 days ago

    Am I the only one who finds the title abrasive? Why “rules”? Who are you and why should I listen to you? Will you send the tutorial police around if I ignore you? Maybe “recommendations” would be a better choice?

    • MagicShel@lemmy.zipEnglish
      7·
      4 days ago

      Unless it’s filled with specific uses of MUST, SHALL, and MAY, it’s just opinion. This is the internet, so the IMO SHALL be assumed.

    • SwordInStone@lemmy.worldOP
      3·
      4 days ago

      not my title, but it is kinda in your face.

      I agree “recommendations” or “pointers” would not come across as so selfğrighteous