10

> Project does X
< How about you show me how X looks in action
> No

Add fucking images to your project
if there is anything to show off!

Uh I reached 3k, cool.

Comments
  • 2
    100% agreed.
    If the software is doing something with a user interface or having some visual impact, then show it.

    Imagine as a developer working weeks/months on a project, but being to fucking lazy to put a screenshot in their README.md
  • 2
    @thebiochemic Yes, you can literally drag and drop images onto GitHub, so there is not excuse.

    ( Though that isn't very nice in terms of documentation )
  • 0
    I get it.

    The last thing I want to do after a sprint is to spend more time explaining why the system I've just spent weeks working on does what it does, and under what situations it looks the way it looks.

    Especially knowing that no matter how well I explain or demonstrate something, the users will always ask an obvious question with an answer in the manual that I didn't want to write.

    If they're going to ask me questions no matter what, I might as well save myself time.
  • 3
    @cuddlyogre You only get the same amount of questions for projects with or without documentation because projects with documentation attract ten to hundred times the amount of users.
  • 1
    @cuddlyogre you spending the time saves the users using the software time. A net positive and quality improvement after all.

    you not spending the time to do that, will sooner or later drive away users, since they don't fully understand something, or don't know how to work with it.

    Personally you can win me with good documentation, but you will loose me pretty quickly, if it is shit and doesnt show stuff. I will personally make sure to avoid the software/library and warn others about the lack of documentation. This obviously has caveats, but that is usually how things work for me.
Add Comment