logoalt Hacker News

Ringz11/21/20241 replyview on HN

Not only are screenshots often missing, but I’m also surprised by how many projects fail to describe the purpose and goals of their project in short, simple sentences. Many mistakenly assume that only users and developers visit the website or repository, not decision-makers. More ELI5 ("Explain Like I'm 5") can never hurt.


Replies

majkinetor11/21/2024

Writing good documentation is extremely hard. Even 10x engeneers can be basically illiterate.

show 1 reply