Workbench Documentation: Best Practice Template

If you're looking for a ready-to-use template, I'd recommend the one made by @Lars de Vries​: https://hub.safe.com/publishers/lars-de-vries/templates/omkeere_template-workbench

Other recommendations, and I'm sure my colleague @inge​ would be happy to chime in:

• If you agree, organisation-wide, on one style of connections (straight, square or curved) that would be highly recommended. A workspace that's e.g. designed with straight connections but opened in Workbench set to curved connections may not be as clear as you'd like it to be.
• Focus more on documenting why you are doing things rather than what you are doing.

Thank you @Hans van der Maarel​. All very useful tips. What I am aiming for is like a Word Template (other word processing tools are available) so that non-FME users and new FME users can see which workbenches we have, what they are doing and why.

Interesting, it just so happens that I've got a meeting planned with a customer who's trying to do exactly that.

Another approach is to make up a document when you start developing a workspace (and keep that updated). We've got a template for that, albeit in Dutch, containing stuff like contact details for whoever is the "client" of this workspace, overview of source and target data, what should happen if it goes wrong, how often should it run, how should it be triggered etc.

Thanks @Hans van der Maarel​ , The word template sounds exactly what i was looking for too - is there any chance it could be shared publicly??

Here you go. We are currently reconsidering our approach to this. As a non-technical colleague pointed out, quite often you develop FME workspaces for people who don't actually care what tool you use, they just want their problem fixed. Some of the questions we initially had were very FME specific and we're in the process of reworking to something that's much more goal-oriented.

Hi @Hans van der Maarel​. Thanks for your input. The template you recommended has been great. I recently revisited the Word template idea so your response is quite timely. I'll give it a read and weave it into what I've already done. I have also been working on some naming standards for workbenches, server repo's, schedules and automations. It's still a work in progress but you're welcome to have a look.

@djmcdermott​ thanks for sharing, all very useful templates which can be added too. I think this, although not a true FME issue, is something that has been missing for sometime - I certainly want to document my creations so other know what they do..

Thanks again