14 posts MosaicPRO Team
  • Has sold $125,000+ on Envato Market
  • Sells items exclusively on Envato Market
  • Has collected 50+ items on Envato Market
  • Has been part of the Envato Community for over 4 years
+2 more
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
  • Has sold $100+ on Envato Market
  • Has been a beta tester for an Envato feature
  • Has collected 1+ items on Envato Market
  • Sells items exclusively on Envato Market
+2 more
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
14 posts MosaicPRO Team
  • Has sold $125,000+ on Envato Market
  • Sells items exclusively on Envato Market
  • Has collected 50+ items on Envato Market
  • Has been part of the Envato Community for over 4 years
+2 more
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
  • Has sold $100+ on Envato Market
  • Has been a beta tester for an Envato feature
  • Has collected 1+ items on Envato Market
  • Sells items exclusively on Envato Market
+2 more
BenSheppard says

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

14 posts MosaicPRO Team
  • Has sold $125,000+ on Envato Market
  • Sells items exclusively on Envato Market
  • Has collected 50+ items on Envato Market
  • Has been part of the Envato Community for over 4 years
+2 more
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
  • Has sold $100+ on Envato Market
  • Has been a beta tester for an Envato feature
  • Has collected 1+ items on Envato Market
  • Sells items exclusively on Envato Market
+2 more
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

Helpful Information

  • Please read our community guidelines. Self promotion and discussion of piracy is not allowed.
  • Open a support ticket if you would like specific help with your account, deposits or purchases.
  • Item Support by authors is optional and may vary. Please see the Support tab on each item page.

Most of all, enjoy your time here. Thank you for being a valued Envato community member.

Post Reply

Format your entry with some basic HTML. Read the Full Details, or here is a refresher:

<strong></strong> to make things bold
<em></em> to emphasize
<ul><li> or <ol><li> to make lists
<h3> or <h4> to make headings
<pre></pre> for code blocks
<code></code> for a few words of code
<a></a> for links
<img> to paste in an image (it'll need to be hosted somewhere else though)
<blockquote></blockquote> to quote somebody

:grin: :shocked: :cry: Complete List of Smiley Codes

by
by
by
by
by
by