Hacker News new | ask | show | jobs
by voakbasda 1614 days ago
An author of an open source project may do what they want, including using emoji in documentation like this.

On the flip side, I would never allow that code to be used in any of my projects, nor would I want to work with any contributors that think it is a "good" practice (nevermind "best"). To my mind, this documentation screams "unprofessional". I would be embarrassed to show it to any of my customers.

The code is not be the only thing by which a project should be judged. Bad documentation is worse than no documentation, because the author had a choice about the format and style that will be used. This project chose... poorly.

1 comments

That use of emojis gives me a headache, but I (young) do believe that a bit of lightness in otherwise dry topics is extremely important.

What the hell is professionality? Wikipedia says something along the lines of "standards of education and training that prepare members of the profession with the particular knowledge and skills necessary to perform their specific role within that profession".

A (considerate) use of emojis, images and jokes (basically: anything that isn't dry text) can work wonders to make a document more digestible, leading to more effective transfer of information and increased enthusiasm for your brand. I would consider that doing your job quite effectively.

Totally depends on the target audience, of course. I have experienced instances of "over-doing it" before (this is one of them), so I do empathize with the more boring people of the industry a little. But not overly much. "No fun allowed" mentalities can massively hurt morale (remember: this costs money), in my opinion.