3 ms·
I wish programmers would also follow this advice when creating their GitHub repositories and project sites because they can suffer the very same problem. It's
by petercooper 14y ago
I wish programmers would also follow this advice when creating their GitHub repositories and project sites because they can suffer the very same problem.
It's pretty often I hear about a library or project, hit its homepage, and I can't figure out what the heck it even is without digging around.
The magic phrase, as used in this article, is "[thing] is [describe thing]". Tell me the name of your thing and what it is. Once you've got that paragraph out of the way, you can go to town!
- mikk0j 14y agoCompletely agreed. Like pointed above by venus, the "best for" format may annoy some people and is not necessary in all cases. Your more generic example works as a better template.
- DanBC 14y ago> The magic phrase, as used in this article, is "[thing] is [describe thing]". Tell me the name of your thing and what it is. And "[thing] is [describe thing]" does not mean "[thing] is [like other thing but for X]", because I have no idea what other thing is either.