13 posts MosaicPRO Team
  • Elite Author
  • Exclusive Author
  • Referred between 100 and 199 users
  • Has been a member for 3-4 years
  • Bought between 50 and 99 items
  • Sold between 100 000 and 250 000 dollars
mosaicpro says

Hi everyone,

We’re kinda new here, so we’ve got our first item approved and noticed the documentation was rated as “Some help”. What does that even mean? What should we do for this documentation to be rated as Well documented?

Here’s the documentation in question: http://mosaicpro.biz/beautyadmin/dev/documentation.html

PS. We’re not saying that the current documentation IS really well documented, but “Some help” sounds a bit … like there was no effort at all put in the writing and it’s format – not that nice, we think.

With that in mind, what we’re really asking is: what should this documentation have in order to be considered a “Well documented” item.

Thank you all in advance.

1034 posts
  • Microlancer Beta Tester
  • Exclusive Author
  • Sold between 100 and 1 000 dollars
  • Bought between 1 and 9 items
  • United Kingdom
  • Has been a member for 2-3 years
BenSheppard says
Well it just says what’s included not how to edit it, if you want “good” documentation you need to describe everything, how to edit it and use it in the easiest way possible

Heading 3


<h3>Heading 3</h3>

Kind of thing
13 posts MosaicPRO Team
  • Elite Author
  • Exclusive Author
  • Referred between 100 and 199 users
  • Has been a member for 3-4 years
  • Bought between 50 and 99 items
  • Sold between 100 000 and 250 000 dollars
mosaicpro says

BenSheppard I seriously think you are wrong.

First of all this is an Admin Template which means it will be implemented by someone with some fair knowledge of HTML.

I don’t think that showing the style of headings in this format:

Heading 1 h2. Heading 2 H3. Heading 3 h4. Heading 4 h5. Heading 5 h6. Heading 6

as oppose to what you’re saying :

h1. Heading1

would affect the value of the documentation especially being the case in the Admin Templates where I think it’s more about showing where and how each feature is structured.

We have spread the documentation in:

http://mosaicpro.biz/beautyadmin/dev/documentation/getting-started.html http://mosaicpro.biz/beautyadmin/dev/documentation/customization-guide.html

See tabs…

Personally I think the reviewer skipped looking at the new documentation and it’s sections.

P.S. I have seen other Admin templates with 30% of what we detailed in there.

1034 posts
  • Microlancer Beta Tester
  • Exclusive Author
  • Sold between 100 and 1 000 dollars
  • Bought between 1 and 9 items
  • United Kingdom
  • Has been a member for 2-3 years
BenSheppard says

“Documentation Well Documented” but sure ask for advice and don’t listen to it

13 posts MosaicPRO Team
  • Elite Author
  • Exclusive Author
  • Referred between 100 and 199 users
  • Has been a member for 3-4 years
  • Bought between 50 and 99 items
  • Sold between 100 000 and 250 000 dollars
mosaicpro says

BenSheppard,

Thank you for your advice, well taken & appreciated. We’ll update the documentation as detailed as possible.

One more thing, do you think we need to contact support to rate the documentation after we upload an update?

Thanks.

1034 posts
  • Microlancer Beta Tester
  • Exclusive Author
  • Sold between 100 and 1 000 dollars
  • Bought between 1 and 9 items
  • United Kingdom
  • Has been a member for 2-3 years
BenSheppard says

BenSheppard,

Thank you for your advice, well taken & appreciated. We’ll update the documentation as detailed as possible.

One more thing, do you think we need to contact support to rate the documentation after we upload an update?

Thanks.

Well the doc is included in your files so it’ll have to go through submission, so mention you’ve updated documentation

by
by
by
by
by
by