Products

Solutions

Resources

Partners

Community

Blog

About

QA

Ideas Test

New Community Website

Ordinarily, you'd be at the right spot, but we've recently launched a brand new community website... For the community, by the community.

Yay... Take Me to the Community!

Welcome to the DNN Community Forums, your preferred source of online community support for all things related to DNN.
In order to participate you must be a registered DNNizen

HomeHomeOur CommunityOur CommunityGeneral Discuss...General Discuss...If you release open source software, please add some kind of documentationIf you release open source software, please add some kind of documentation
Previous
 
Next
New Post
8/30/2014 2:34 PM
 

This morning I downloaded and installed an open source module. I ran it and it showed a form with several inputs. I couldn't deduce what one field is used for or in what format. It kept erroring. I checked the module zip file for any documentation. Nothing. The site had nothing. Just one install module and one source module. 

While some piece of software might be free and I should be happy, it still bugs me that I have to spend an inordinate amount of time figuring it out and conclude it's not something which will work for me. If a developer takes hours or days to develop some software, take 5-10 minutes and jot down some quick getting started info or some explanation for the input fields. We don't expect any fancy documentation.  A text file with spelling and grammar mistakes is better than nothing. Don't worry about styles. It amuses me when a developer takes time to include a long detailed ReleaseNotes text file with mention of every minor version and bug fix but doesn't have any kind of documentation. To a user which file is more important!? When I download some software I have zero interest what the prior versions did and what got fixed. I want software that is the latest version, that works now and I want to understand it quickly.

 

So please be considerate and include some quick docs. Our time is also valuable. Don't waste the time of tens or hundreds of users because you were too lazy to write something down. Put yourself in the shoes of a user who knows nothing of your software and pretend you're using it for the first time and then write some docs and examples for areas that thser user mightbe lost. Or at least give it to a friend and ask them which areas they had difficulty with and make that easier either in the UI or in some documentation.

 
New Post
8/30/2014 2:43 PM
 
If you are talking about Form and List, there used to be a user manual when I was project lead a couple of years ago, I am not sure, whether it is still maintained.

Cheers from Germany,
Sebastian Leupold

dnnWerk - The DotNetNuke Experts   German Spoken DotNetNuke User Group

Speed up your DNN Websites with TurboDNN
 
New Post
8/30/2014 3:04 PM
 

It's not Form and List and I won't mention which one :) Now every module which doesn't have any kind of documentation is a suspect.

 
Previous
 
Next
HomeHomeOur CommunityOur CommunityGeneral Discuss...General Discuss...If you release open source software, please add some kind of documentationIf you release open source software, please add some kind of documentation


These Forums are dedicated to discussion of DNN Platform and Evoq Solutions.

For the benefit of the community and to protect the integrity of the ecosystem, please observe the following posting guidelines:

  1. No Advertising. This includes promotion of commercial and non-commercial products or services which are not directly related to DNN.
  2. No vendor trolling / poaching. If someone posts about a vendor issue, allow the vendor or other customers to respond. Any post that looks like trolling / poaching will be removed.
  3. Discussion or promotion of DNN Platform product releases under a different brand name are strictly prohibited.
  4. No Flaming or Trolling.
  5. No Profanity, Racism, or Prejudice.
  6. Site Moderators have the final word on approving / removing a thread or post or comment.
  7. English language posting only, please.
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out