3 ms·
I have worked extensively on the documentation for the Defold game engine (see https://www.defold.com/learn/ https://www.defold.com/learn/). Here's a few things
by sicher 8y ago
I have worked extensively on the documentation for the Defold game engine (see https://www.defold.com/learn/ https://www.defold.com/learn/). Here's a few things we've done:
We use Google tracking on the site. That helps a bit. We have search available on the site and we get the most useful information from how people use the search function. We get clues as to what users are looking for, what terminology they use and I use that to make sure common searches turn out good information.
I added a "Have a suggestion?" button at the bottom of each page. You have to be logged in to see it (because of bots) but it allows you to mark text directly on the page and then report errors and suggestions. We get a lot of feedback through it, much, much, much more than before when we relied on users sending their feedback or stopping by to talk.
- andygcook 8y agoGood instincts on the suggestions feature idea. My startup builds internal documentation software. We built that exact feature and our customers really like it. The problem with most documentation is that it goes out of date. Wrong docs are often more detrimental than no document at all. Allowing readers to flag information that might be wrong, or even suggest an update to merge, helps to harness a team’s collective knowledge to keep documents updated.