Many Tealium products use a shared configuration environment.  Those environments often grow in complexity as they are iterated upon by many 'generations' of users over a period of years.

It's essential to the long-term success of those configurations that each user contributes to documenting their changes and follows Tealium's best practices.

These practices include:

Leaving comments and notes

All our tag templates and all of the non-JavaScript type extensions include a footer that you can add notes into. It is important we take advantage of this field and add useful information regarding the configuration. 

 

notes.png

In those notes, focus on the WHY instead of the WHAT.

For example, when manually removing a cookie with a TiQ extension:

  • DO write 'need to remove cookie xyz because it's out of date, adds page bloat, and is replaced by cookie abc in new tag version'
  • DON'T write 'remove cookie xyz from page' (which is easy enough to work out),

This is especially true for any odd configuration.

If, as an extreme example, you are leaving behind a tag that is deliberately switched off, but must not be activated or removed, explain WHY instead of cryptically writing "Don't activate or remove".

This process also applies to JavaScript extensions. In the extensions, we must follow industry-accepted best practices when adding comments to our code. Adding a code block to the top of every JavaScript extension that explains why it was added, when it was added, and the purpose behind the code will help future users understand the configuration. Additionally, adding in-line comments should be used to help guide other users through the intricacies of the code. 

Cleaning up as we go

We shouldn't leave unused configuration behind. If a tag is outdated and no longer being used, it should be deleted. Alternatively, if we are disabling tags for any reason, we must note the deactivation date for reference and add why it's being deactivated so future users can make informed decisions.

Using labels to group components

Labels help newcomers orient themselves and more seasoned team members find their way around more quickly - it's a very good idea to use them. This becomes more and more important as the configurations grow larger.

Version history
Last update:
3 weeks ago
Updated by: