Live data from Hacker News

WTFM - Write The Freaking Manual

floopsy.com

81–82 of 82 posts

Re: WTFM - Write The Freaking Manual

#81
post #38
post #22

Earlier quoted context omitted.

GitHub READMEs are an excellent compromise. Doing more detailed docs are quite a lot of effort (that is better spent coding), especially to projects that are at an early stage. Projects which are an early stage (like most of my projects) should mostly try to attract potential contributors, not just consumers/end-users so it's not unreasonable to require would-be users/contributors to walk the extra mile and actually…

There's a double standard here. You want developers to contribute to your project despite the lack of documentation but you require that libraries you contribute to are well documented.

> ...but you require that libraries you contribute to are well documented.

You misread me. I almost never read the docs because they suck more often than not. I start from example and test source code and almost always end up reading parts or most of the source code.

Re: WTFM - Write The Freaking Manual

#82
post #81
post #38

Earlier quoted context omitted.

There's a double standard here. You want developers to contribute to your project despite the lack of documentation but you require that libraries you contribute to are well documented.

> ...but you require that libraries you contribute to are well documented. You misread me. I almost never read the docs because they suck more often than not. I start from example and test source code and almost always end up reading parts or most of the source code.

> If there actually were libs that are well documented and do the same thing...

I thought you were implying that you required libs you contribute to to be well documented.

Post reply on HN