Laatst bijgewerkt:
Wanneer engineers of productmanagers naar een SUMO-ondersteuningsartikel koppelen vanuit een product (zoals Firefox), moeten ze altijd een stabiele URL gebruiken, en niet de rechtstreekse artikelkoppeling. Rechtstreekse koppelingen wijzigen wanneer de titel of de slug wordt bijgewerkt, wat ervoor kan zorgen dat koppelingen in producten niet werken. Stabiele koppelingen beschermen hiertegen en zorgen ervoor dat gebruikers altijd de juiste pagina bereiken.
Dit artikel legt uit waarom stabiele koppelingen belangrijk zijn, hoe ze moeten worden opgemaakt voor verschillende platformen, en hoe er een kan worden opgesteld met het Kitsune-dashboard.
Inhoudsopgave
Waarom stabiele koppelingen belangrijk zijn
Het gebruiken van rechtstreekse koppelingen naar ondersteuningsartikelen (zoals https://support.mozilla.org/nl/kb/voorbeeldartikel) kan tot problemen leiden:
- Ze raken gemakkelijk defect: URL’s naar artikelen wijzigen als de titel wijzigt, tenzij de schrijver de slug handmatig behoudt.
- Ze zijn niet localiseerbaar: rechtstreekse koppelingen bevatten een hardgecodeerde taal, wat niet ideaal is voor internationale gebruikers.
- Ze zijn moeilijker te beheren: we kunnen ze niet globaal bijwerken als ze rechtstreeks in het product worden gebruikt.
Daartegenover geldt voor stabiele koppelingen:
- Ze blijven consistent, zelfs als de artikel-URL wijzigt;
- Ze detecteren automatisch de juiste taal;
- Ze kunnen desgewenst worden doorgeleid of centraal worden bijgewerkt.
Koppelingsopmaak voor in-product-ondersteuningsartikelen
Gebruik een gestandaardiseerde opmaak om stabiele ondersteuningskoppelingen te maken voor desktop- en mobiele producten:
Opmerkingen:
-
%VERSION%,%OS%en%LOCALE%worden automatisch door het product ingevuld. - Het SUMO-team maakt de velden
<slug>en<product>. - Vervang
<slug>door de door u aangemaakte unieke slug.
Deze opmaak zorgt ervoor dat gebruikers naar het juiste gelocaliseerde artikel worden verwezen.
Voorbeeld:https://support.mozilla.org/1/firefox/%VERSION%/%OS%/%LOCALE%/recommendations-firefox-new-tab
Een stabiele in-product-koppeling instellen in Kitsune
Volg om een stabiele doorleiding aan te maken deze stappen in het Kitsune-beheerdersdashboard.
- Meld u aan bij het Kitsune-beheerdersdashboard.
- Klik onder INPRODUCT op Redirects.
- Klik in de rechterbovenhoek op .
- Vul de vereiste velden Product, Topic and Target in, zoals beschreven in de sectie Doorleidingsvelden hieronder.
- Klik op .
- Deel de gemaakte stabiele koppeling met de engineer of productmanager, gebruikmakend van de in-product-opmaak:
https://support.mozilla.org/1/firefox/%VERSION%/%OS%/%LOCALE%/<slug>
Doorleidingsvelden
| Veld | Beschrijving |
|---|---|
| Product | Gebruik firefox voor desktop of mobile voor mobiele Firefox-producten.
|
| Topic (slug) |
Voer een korte, unieke identificator in voor het artikel. Deze wordt onderdeel van de stabiele koppeling.
Noot: de slug hoeft niet overeen te komen met de werkelijke URL van het doelartikel. Kies iets betekenisvols en consistents voor productgebruik.
|
| Target |
Het pad naar het ondersteuningsartikel waarnaar u wilt verwijzen. Neem alleen het gedeelte vanaf Voorbeeld:
Noot: u kunt een anker opnemen (b.v.
kb/customize-items-on-firefox-new-tab-page#w_weather) om te verwijzen naar een specifieke sectie. Ankers werken alleen in de Engelse versie en werken mogelijk niet in andere locales. |
Tips
- Stabiele koppelingen zorgen voor localisatie: gebruikers worden automatisch doorgeleid naar hun voorkeurstaal, als deze beschikbaar is.
- U kunt later stabiele doorleidingen bijwerken of verwijderen via de Kitsune-beheerdersinterface.
- Gebruik deze methode wanneer u koppelt vanuit:
- In-product berichten voor ‘Meer info’;
- Welkomstflows;
- Fout- of waarschuwingsberichten;
- Contextuele hulponderdelen.
