4 ms·
There's nothing wrong with what you are doing. There is no law that states that all open source libraries in the world should be perfectly documented, and have
by ilyagr 12y ago
There's nothing wrong with what you are doing. There is no law that states that all open source libraries in the world should be perfectly documented, and have a set of tutorials that would gently teach anyone as much as he wants about how to use it. Writing documentation and/or tutorials is hard work, and the larger your target audience is, the harder and more time-consuming it is.
I don't think your library will be generally useful to a large audience until you or someone else writes better documentation for it. But you don't have to target a large audience. It's quite likely that when someone else has the same problem, it would be faster for them to reuse your library than to write their own. They might even document the process.
I don't think I'm qualified to give any specific advice, but here's some general suggestions which may or may not be to the point. If you are sufficiently motivated, you should decide who your target audience is, and write enough documentation for them. For example, for an advanced audience, it might be useful to say a few words the general design of your library, explain which problems your library does solve and (more importantly) what the limitations of the design are, perhaps outline anything in the design that is strange or unexpected, but useful from your experience. The most important thing for them to know quickly is whether your library can actually solve their problem (which is probably slightly different from the problem you solved), whether it is actually faster to use your library than to roll their own. If they really need to, they'll figure out the rest. The end result might be closer in style to a CS paper than a tutorial.
Oh, and one thing you really should fix: it is annoying that the haddock documentation is not available on Hackage at the moment, and probably not searchable on Hoogle as well.
Again, there's nothing wrong with your library, you are doing a good thing open sourcing it, and any time you put in describing it and explaining it to people is valuable. Just keep doing more of what you are already doing.