Back to Ideas
9
Like
Follow Idea
Make user manuals mandatory for Forge components
1388Views
10Comments
Implemented
Forge

I propose to make it mandatory that Forge components have user manuals.

The problem:
The quality and usefulness of Forge components vary wildly. 


One of the attractions of OutSystems for new clients is the Forge. They expect a wide range of great quality and easily usable components supported by OutSystems. They will soon discover that the Forge doesn't live up to their expectations.

One of the solutions:

Most Forge components come with no documentation at all. A 3-row general description in the Details section is all there is. 

To enhance the quality of the component and thus the overall quality of the Forge I propose a mandatory user manual.

With this, I mean a document/manual that describes what the component does, what it contains and how to use it, preferably with examples. This will greatly enhance user insight and easier/quicker adaptation of the Forge component.  

26 Oct 2018
Copy link to comment

The idea is good, there are already news on this road for next month (spoiler).

26 Oct 2018
Copy link to comment

Considering that Forge components are free and the people who create them get $0 or other compensation for their time, I think that requiring any additional effort on their part will result in fewer components.

Now, perhaps if the people who actually use the components actually took some time to give the component creators a good reason, maybe then this makes sense.

But as someone who has seen thousands of uses of components, who has more components in the Forge than just about anyone else, and has yet to get so much as a "thank you", it will be tough to demand that I write you a manual as well.

J.Ja

29 Oct 2018
Copy link to comment
Changed the category to
Community Forge
21 Nov 2018
Copy link to comment
Changed the status to
Working on it
expected delivery in Q4 2018

we are working on it.

03 Dec 2018
Copy link to comment
Changed the status to
Implemented
on 09 Jan 2019

hi Hans


this idea was done


Cheers

Ana

09 Jan 2019
Copy link to comment
Merged this idea with 'Forge Component' (created on 13 May 2020 13:05:04 by Srinivas Singadi)
16 May 2020
Copy link to comment

Hi Outsystems,


While uploading the Forge component, is it possible to make documentation tab mandatory, by doing this everyone will put their documentation so everyone will get a benefit and its become essay to use.

Thank you,

Srinivas



This comment was:
- originally posted on idea 'Forge Component' (created on 13 May 2020 by Srinivas Singadi)
- merged to idea 'Make user manuals mandatory for Forge components' on 16 May 2020 23:55:03 by Justin James
13 May 2020
Copy link to comment
Changed the category to
Community Forge


This comment was:
- originally posted on idea 'Forge Component' (created on 13 May 2020 by Srinivas Singadi)
- merged to idea 'Make user manuals mandatory for Forge components' on 16 May 2020 23:55:03 by Justin James
13 May 2020
Copy link to comment

yes its  a good idea



This comment was:
- originally posted on idea 'Forge Component' (created on 13 May 2020 by Srinivas Singadi)
- merged to idea 'Make user manuals mandatory for Forge components' on 16 May 2020 23:55:03 by Justin James
13 May 2020
Copy link to comment

I too agree



This comment was:
- originally posted on idea 'Forge Component' (created on 13 May 2020 by Srinivas Singadi)
- merged to idea 'Make user manuals mandatory for Forge components' on 16 May 2020 23:55:04 by Justin James
13 May 2020
Copy link to comment