Soft Rejected : The documentation is a little lacking


#1

Hi guys, I am working on a Youtube Full HTML Application, here is the link for the Live Demo : http://xioyuna.com/playtube/

But I had a soft rejection, here is the comment of the Quality Team :

The documentation is a little lacking.

Most importantly, remember that buyers may not be technically inclined. They may just be looking for an item to drop into their existing code base. Also keep in mind that a typical user won’t really know about all the features your system brings to the table. With them in mind, you should also look into providing a quick start guide of some sort. It need not be long: a short one will do.

You can use a premade template or the Documenter tool for your documentation, both linked below:
http://themeforest.net/forums/thread/the-documenter/40757?page=1
http://themeforest.s3.amazonaws.com/108_helpFile/Template.zip

And here is the documentation included in the main file : http://xioyuna.com/playtube/documentation/

I don’t know what should I do. I can’t make a shorter documentation because all the necessary steps to configure the application are explained in the documentation, and I think my documentation is prettier and clearer than the default template that offers Envato.

So I can’t make a shorter documentation because all the steps are essentials, and I’m not going to entirely rewrite documentation using their less elegant template ?

Please help me :stuck_out_tongue:


#2

I think they need documentation in one file configuration, this mean you can change - add - edit - remove some main feature in your application in one file instead separate it.


#3

Ok but it is not possible for technical and performance reasons. Some steps are essentials and I can’t remove them :confused:


#4

I don’t believe that the comment actually states that the documentation is too long, it’s actually the opposite - “The documentation is a little lacking.”

It mentions that you haven’t covered some of the features that your system brings to the table - meaning you should provide a quick start guide of some sort - and this quick start guide should be short, not the whole documentation.


#5

Ok so what I understand is that I have to add a short quick start guide for use my item. But the documentation is the start guide !

I clearly explain :

To configure PlayTube, you need 3 informations : A Youtube API Key, your Youtube channel ID, and your Youtube channel playlist ID. Here is how to get them.

And I made a step by step guide for get these informations. I can not make it shorter or longer …

Maybe that the review team expects me that I have to explain how the code is written ?


#6

You haven’t explained to people how to upload files to servers, etc.

You have to be very descriptive.


#7

Are you sure I have to explain this ?

There are limits, in the description, I have said there needs a web server, and from the moment you have a web server and you buy something on CodeCanyon, I assumed that people know how to upload files to a server. When I created a theme on Themeforest, I do not explain how to upload the site on the FTP. I will not also explain how to turn on a computer ^^


#8

Hey, Xioyuna. I have a very similar problem and I’m wondering how your troubles ended up. Have you been able to upload PlayTube eventually. What did you have to change?