What is your best way to reference ServiceNow documentation in your own documentation?

Philippe Casidy
Tera Guru

Hi Everyone!

 

I am writing documentations for developers internally. And often times, I want to reference ServiceNow documentation so I would put a link to ServiceNow documentation or developer website...

My problem is that those links are tainted with a version of ServiceNow (currently Tokyo).

Which would mean that when a new version is out, I would have to update my links if I want to always reference the latest documentation (or the version we just updated to).

 

I would like to avoid to update all my links with the version.

 

I would accept that my links gets deprecated because the article has been moved. I would accept that latest version express an opposite argument to that I wrote or what the previous version said.

But I don't want to open all my documents (word or pdf) and search and replace in all of them.

 

Thanks

Philippe

1 ACCEPTED SOLUTION

Maik Skoddow
Tera Patron
Tera Patron

Hi @Philippe Casidy 

you can find the answer in my article Better Linking of ServiceNow Documentation Pages.

For my Knowledge Sources To Go I cannot afford spending hours of my time to correct links after each family release

Maik

View solution in original post

5 REPLIES 5

Philippe Casidy
Tera Guru

Thanks a lot!

 

Works pretty well... thought when there is an anchor, seems I have to refresh the page after link has been adapted by ServiceNow...

For example, a link like

https://developer.servicenow.com/dev.do#!/reference/api/latest/server_legacy/c_GlideRecordAPI#r_Glid...

will redirect to a place near "get()".
But if I refresh, I got the correct location.

 

Strange. Have you experienced this?

I have the same behavior in both Edge and Chrome.

 

Thanks

Philippe