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

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

Hi @Maik Skoddow 

 

Thank you but is this Better Linking of ServiceNow Documentation Pages article gone?
The link is not working for me. I am redirected to /community .

 

I even found this link in your My collected list of ServiceNow tips & tricks - ServiceNow Community (which I used two days ago - again thank you) but same result.

 

Impressive your "Knowledge Sources To Go"... there I can see what kind of links you are using 🙂

 

That helped using "latest" version.

 

Still would be happy to read your original article. Do you think you can find it back? Then I would wait for your latest link to mark a solution.

Thanks again.
Philippe

Hi @Philippe Casidy 


sorry, it seems that with the migration from the old Community portal to the new one last year, that article was dropped. And it is the only article I cannot find anymore 😞

 

But the URL pattern is simple: 
https://docs.servicenow.com/csh?version=latest&topicname=monitor-requests-using-aemc.html

 

You just have to replace the red portion with the last part of the original URL.

 

Maik.

Allen Andreas
Administrator
Administrator

Hi,

Here's a nice article from Mark that explains things a bit: https://www.servicenow.com/community/now-platform-blog/linking-to-most-recent-servicenow-docs-pages-... 

Takes a slight moment to adjust the URL, but it does work 😀


Please consider marking my reply as Helpful and/or Accept Solution, if applicable. Thanks!