Fang Talks

Gullible

Because you can’t tell your users to Read The Fucking Manual otherwise.

If there’s one thing that’s important for young projects, it’s already adopters. If there’s one thing that’s important for getting and retaining early adopters, it’s documentation. There’s very few people who are going to use your software if they have to figure everything out for themselves. Really small projects may get away with this, but anything more complex than “there’s two buttons and an input field” will likely require some form of elaboration for things to become 100% clear.

Documentation is important for people to learn how to use (and contribute to) your software, but writing good documentation is hard. Like, really, stupidly hard. You are not your audience, and you never will be. You made the thing, so you know how it works, but you have no idea what your audience knows. What can you get away with not explaining while still painting a clear picture? Obviously a line has to be drawn somewhere.

If you can’t write beginner-friendly documentation, then maybe try writing intermediate-friendly documentation. Those people can then help you gain insight in what was missing, where the stumbling blocks were, and you can improve your documentation from there. Any documentation is always better than none, and it can always be improved.

Also saves you time explaining things if you can just point to the appropriate page in the docs.
~ Fang

Post a comment

Your email will stay hidden, required field are marked with a *.

Experimental anti-spam. You only have to do this once. (Hint: it's "Fang")