Documentation needed

Table of contents
No headers

Please add to the list of documentation below that needs to be added:

  • Desktop Suite
  • Extensions explained for non-developers 
  • A place where users can file questions and offer additions to the primary user guide. 
  • A troubleshooting FAQs with quick answers or references for common problems (such as the password for VMWare).
  • Clean up Authentication Documentation 
  • Why Roy is awesome
  • Enabling Spell Check on Windows installs - tied to this documentation - Have overview of iespell
  • Have article about setting up Deki for polyglot - Done
  • Making customizations to the Resources file to change wording in the interface/emails
  • Checklist for deployment - what hardware to use, OS, etc.  Done
  • Improve Performance for Deki - Steps to improve the speed of Deki for Anonymous users and for logged in users - Done
  • Add to network configuration how to add a custom URL to Deki for Custom Deployments ...i.e. not wik.is Done
  • Breakdown of release notes on one page to show when functionality was added, beneficial to users upgrading from older versions to get an idea of functionality that will be added Done
  • Notes on the Auth intro that explains if you have a local user with the same username as an AD/LDAP user then a new account will be created with a 1 appended to it.
  • Include a link in the install Docs that points to how to apply an Enterprise License
  • Clarify the reordering of Hierarchy in documentation (need to move first and then change the name)
  • Add documentation for the attachments dialog like move, delete, edit description etc
  • Add code samples to API functions
  • Add more CSS override samples and Skin examples
  • Clarify the email notifications configuration 
Tag page
Viewing 5 of 5 comments: view all
Is the stuff at that link supposed to be in English? I don't like having to use VMWare, but it's all that's available. I have Word XP but production version will be on Windows Server, so I really don't want to have to learn to be a developer just to manage a temporary test site. Yet links with "solutions" about my test site problems often seem to require me to search for other links so I can understand what's in the first link...
I don't mean to sound testy or mean, and I do appreciate the fact that you're working on this (and a thousand other things). I just think your have a terrific product that could probably be used by nontechnical administrators, but the mindset seems to be that all users are at least moderately technically proficient. edited 17:27, 26 Nov 2008
Posted 17:21, 26 Nov 2008
Deki is server software. Most server software requires some level of technical proficiency. For those who prefer a hands-off-it-just-works approach, please check out Deki Express, which is hosted and almost feature identical: http://www.mindtouch.com/Products/OnDemand
Posted 18:19, 26 Nov 2008
But if I want to use it on an intranet, I don't need a host, do I?
Posted 19:18, 26 Nov 2008
It's possible to use a hosted solution also for Intranets by making the site private. However, if you want 100% control over the site, then install the VM, MSI, or source packages on an internal server. Of course, that means you'll need to do the maintenance yourself.
Posted 19:29, 28 Nov 2008
You might expect technical proficiency, but it's unrealistic to assume that all of your users are technical, and you might not want to cater for non-teccie people, but we are paying customers and therefore we should be catered for better than we currently are. I am not technical, but will definitely become more knowledgable about HTML/CSS/Scripts etc over time as I do more and more with the wiki, which is somehting I am looking forward to. To suggest to Wordsmith (and therefore the rest of us <teccies) that we should perhaps look at something a little less challenging isn't really very helpful. You should be doing a better job of explaining how things work. You do assume knowledge, which is not surprising as you're all very technical people yourself. But you are selling a product that is inadequately documented (don't worry I'm our wiki champion and think dekiwiki is great). I've been looking at your docs on using dekiscript and it starts off easily enough but very quickly becomes confusing - maybe not to you, but to other people. For a start you need to be consistent about naming conventions, and if you have a FAQ it should be up to date, otherwise it's pretty useless. I appreciate that dekiwiki is growing and there's so many hours in the day, I'm a tech author myself and know the problems all too well - perhaps it's time to consider hiring a proper technical author. The upside of better documentation is it = less support calls, >happier customers and <time spent dealing with comments like these - go on, you know it makes sense! :) Cheers.
Posted 14:45, 30 Jan 2009
Viewing 5 of 5 comments: view all
You must login to post a comment.