On Dec 11, 8:02 pm, real_jax <[EMAIL PROTECTED]> wrote: > I know writing documentation is very unrewarding. I have been there myself > lots of times. > But having a lot of documentation and having people complain about the > documentation at the same time should ring a bell. Maybe the documentation > is not so easy to find? Maybe users have to resort to the documentation > where they really shouldn't ?
Fair enough :) But I'd repeat my earlier point. "People need to point out what documentation they need most -- play editor, indicate where things are not clear, and so on. That assists the community as a whole to focus on the areas of documentation that need the most attention." Throw us a bone and let me know what you would like to see changed, added or removed. > The problem is most regular users do not want to be weighed down by > the addition of inline hints and tooltips. Especially when most > things in the UI itself are mainly self evident. The user > documentation that is generally needed is "what is news and how do i > publish it?" and not "What does the Publish Date mean?". So the level > of inline documentation tends to trend to minimal. > > Now here I strongly disagree with you. Inline documentation is very > important. Very. > And what you or other developers may find self evident, may not be so self > evident to other users. Don't get me wrong -- I'm happy to see tool-tips. I'm reporting what users have said in versions gone by. Users are not always right :) And some users are more vocal than others. In truth, I'd like to see more in line documentation -- it's why we've made inline documentation an important feature on the road-map for Fortress, the next release. Did I mention you can modify the in-line documentation by changing component metadata in your own project? That is also an option -- although obviously we want to make the default implementation as good as it can be > Imagine your mum needs to add a new html page to Farcry while you are away. My mum is a FarCry user and one of our harshest critics ;) But your point is well taken, -- geoff http://www.daemon.com.au/ --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "farcry-dev" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/farcry-dev?hl=en -~----------~----~----~----~------~----~------~--~---
