How do you document your Servoy Solutions?

Share business templates, ideas, experiences, etc with fellow Servoy developers here

How do you document your Servoy Solutions?

Postby ProRM » Mon Jun 13, 2022 1:59 am

Hi,

I hope you all are well.

I wonder how do you document your Servoy Solutions and developments? After many years working with Servoy, we still have problems finding where did we use certain method, component or solution. We ended with multiple folders for different Servoy versions and more and more workspaces, so it is difficult to find something when we look for example on how to use a particular component or a sample on how to solve a particular problem.

What do you use in terms of documentation for that? In particular, do you use something to document what solutions are in each workspace and some documentation on what they do?

Best regards,
User avatar
ProRM
 
Posts: 85
Joined: Thu Sep 18, 2008 10:24 pm
Location: Uruguay

Re: How do you document your Servoy Solutions?

Postby rafig » Tue Jun 14, 2022 5:26 pm

I completely get what you are asking here & where you are coming from ;-)

I wish I did document my solutions better, but I think the only thing I can say I try to do is comment as much as possible and fill out the JSDoc as much as I can, so when I come back to something, I can remind myself of what I was doing :D

Rafi
Servoy Certified Developer
Image
rafig
 
Posts: 635
Joined: Mon Dec 22, 2003 12:58 pm
Location: Watford, UK

Re: How do you document your Servoy Solutions?

Postby ProRM » Sun Jun 19, 2022 7:48 pm

Great Rafi,

I would like to know if someone has any kind of app (maybe done in Servoy), where you can document a Solution in terms of what it does, in what workspace is located and that kind of stuff.

I would like to have that kind of tool inside Eclipse in Servoy and i.e. search for "google chart" and see what solutions we already have that have that tag in order to take it as a sample or use it as a module.
User avatar
ProRM
 
Posts: 85
Joined: Thu Sep 18, 2008 10:24 pm
Location: Uruguay

Re: How do you document your Servoy Solutions?

Postby rafig » Mon Jun 20, 2022 3:36 pm

+1
Servoy Certified Developer
Image
rafig
 
Posts: 635
Joined: Mon Dec 22, 2003 12:58 pm
Location: Watford, UK

Re: How do you document your Servoy Solutions?

Postby mboegem » Mon Jun 20, 2022 4:56 pm

sounds to me that you want modules like Servoy releases the 'svyModules'
This could be a specific module for a single or (related) group of component or a more generic module full of 'utils' functions.

Once you have that, store it on your own GIT repository and add it to every project you need this for.

Apart from that you can add 'code templates' to eclipse which are very easy to extend.
Go to eclipse preferences and type 'templates' in the search bar.
Now choose the one in path 'JavaScript > Editor > Templates'
As you can see there are a couple of templates that should look quite familiar to you.

Hope this helps
_____________________
Marc Boegem
Solutiative / JBS Group, Partner
• Servoy Certified Developer
• Servoy Valued Professional
• Freelance SAN Developer

Image
User avatar
mboegem
 
Posts: 1611
Joined: Sun Oct 14, 2007 1:34 pm
Location: Amsterdam

Re: How do you document your Servoy Solutions?

Postby jhilgers » Wed Jun 22, 2022 12:28 pm

This might not exactly be what you are asking for but...

I'm using docfetcher (a fulltext indexer) to do a quick search over multiple directories with sourcecode/workspaces/documentation/... - searching is pretty fast and doesn't need any previous efforts for creating documentation.

I always hated using UML but now I'm using PlantUML to visualize aspects which are more structural. https://plantuml.com
It generates all kinds of diagrams from plane text which can be embedded inside code files optionally (but makes it easier to keep documentation and code in synch ;-)
There's an Eclipse Plugin which can show the Diagrams inside Servoy Developer. This is nice and simple to visualize complicated logic or something like "what was overall changed and where to implement feature X?"
Generating an inheritance tree took me aprox 100 lines of servoy code.
PlantUML ir really good in visualizing dependencies. So if you grab the names of modules used in each solution and aggregate this you'll eventually get a surprising graph.

@startuml
baseform <|-- subform
subform <|-- subform1
subform <|-- subform2
@enduml
best / viele Grüße
Jo ~;-)
jhilgers
 
Posts: 8
Joined: Wed Nov 13, 2019 2:19 pm
Location: Cologne / Germany

Re: How do you document your Servoy Solutions?

Postby ProRM » Mon Jun 27, 2022 8:28 pm

Great tool Jo! I will try it asap.

No one uses any tool to document their solutions/workspaces? We should build one.

Regards,

Juan
User avatar
ProRM
 
Posts: 85
Joined: Thu Sep 18, 2008 10:24 pm
Location: Uruguay

Re: How do you document your Servoy Solutions?

Postby jhilgers » Fri Jul 01, 2022 12:41 pm

Hi Juan,

I have collected my PlantUMl findings and could provide them as PDF -> interested?
best / viele Grüße
Jo ~;-)
jhilgers
 
Posts: 8
Joined: Wed Nov 13, 2019 2:19 pm
Location: Cologne / Germany

Re: How do you document your Servoy Solutions?

Postby ProRM » Fri Jul 01, 2022 11:29 pm

Of course Jo!
User avatar
ProRM
 
Posts: 85
Joined: Thu Sep 18, 2008 10:24 pm
Location: Uruguay

Re: How do you document your Servoy Solutions?

Postby jhilgers » Mon Jul 04, 2022 11:59 am

and here we go!

I will be happy to get any corrections/additions/...
Attachments
220704 plantuml Jo.pdf
(762.72 KiB) Downloaded 26 times
best / viele Grüße
Jo ~;-)
jhilgers
 
Posts: 8
Joined: Wed Nov 13, 2019 2:19 pm
Location: Cologne / Germany

Re: How do you document your Servoy Solutions?

Postby ProRM » Wed Jul 06, 2022 8:29 pm

Great!
Thanks for sharing

Someone uses some tool to keep an index on the Servoy Solutions they have? Something like a Jukebox with a Title, Workspace, a description and things like that?
User avatar
ProRM
 
Posts: 85
Joined: Thu Sep 18, 2008 10:24 pm
Location: Uruguay


Return to Sharing Central

Who is online

Users browsing this forum: No registered users and 1 guest