Skip to main content
Open

Add the Ability to Generate Documentation (PDF, Word, Sharepoint, Web) from Work

Related products:Integrations
  • November 16, 2015
  • 2 replies
  • 18 views
fmelizard
Safer

***Note from Migration:***

Original Title was: Add the Ability to Generate Documentation (PDF, Word, Sharepoint, Web) from Workspaces


I don't know if you are familiar with BizAGI (http://www.bizagi.com/). It's a tool to document "processes". After you described the tasks etc in the process you can generate documentation (PDF, Word, Sharepoint, Web, etc).

I think it would be cool if it was possible to document FME Workspaces in a similar way. If it would be possible to write descriptions in the "transformers", bookmarks could be used to generate structure, different "chapters" in the documentation (in a PDF).

Now I am sometimes using BizAgi to document FME Workspaces. Because FME Workspaces are very "process oriented" it would be nice to be able to generate documentation automatically. It would also force you be able to write even more "clean" workspaces :).

2 replies

J
Forum|alt.badge.img
  • jonathan
  • November 17, 2015
I don't know about bizagi, but I am recently familiar with Doxygen which is a similar concept (automatically creates HTML documentation based on comments within the source code of a program).

 

I think something similar for FME would actually be pretty neat from a process perspective. It could take Bookmarks and use them for grouping. Annotation would become the general commentary (of the process (possibly with tags like doxygen)). After all, while FME is relatively self-documenting, it can still be tricky to determine what a workspace does.

 

maarten
Participant
Forum|alt.badge.img+3
  • maartenParticipant
  • Participant
  • March 25, 2016

This would be very nice. It would have saved me and my co-workers a lot of work documenting workspaces for a client. I would prefer Word, PDF and OpenOffice-formats.

bec
1 person upvoted this
  • bec
    bec

Reply


Helpful Members This Week

Community Stats

31,378
Posts
119,007
Replies
39,007
Members

Latest FME

Terms & ConditionsCookie settings

Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings
A product of
Safe Software respectfully acknowledges that we live, learn and work on the traditional and unceded territories of the Kwantlen, Katzie, and Semiahmoo First Nations.