Skip to content

Latest commit

 

History

History
92 lines (52 loc) · 6.4 KB

File metadata and controls

92 lines (52 loc) · 6.4 KB
source-git-commit workflow-type source-wordcount ht-degree
15070ea99308741242b43206ed69cf1dbddca890
tm+mt
719
4%

Richtlijnen voor het bijdragen aan de documentatie van [!DNL Adobe Experience Manager]

Documentatiefilosofie

We weten dat [!DNL Adobe Experience Manager]-gebruikers in zeer competitieve omgevingen werken en ernaar streven om digitale ervaringen te creëren die hen onderscheiden van hun concurrenten. Daarom is het van essentieel belang dat wanneer Adobe geavanceerde nieuwe hulpmiddelen in [!DNL Experience Manager] levert, deze hulpmiddelen met nauwkeurige en duidelijke documentatie worden aangevuld zodat de klant onmiddellijk zijn [!DNL Experience Manager]-investering kan benutten en zijn investeringsrendement kan maximaliseren.

Het doel van de [!DNL Experience Manager] documentatie is documentatie in de handen van [!DNL Experience Manager] gebruikers te zetten zo spoedig mogelijk. Daarom geven wij prioriteit aan nauwkeurige, bruikbare documentatie en streven wij ernaar deze voortdurend bij te werken en te verbeteren.

Documentatiebijdragen

Om de [!DNL Experience Manager]-documentatie voortdurend te verbeteren, is de hele community van [!DNL Experience Manager]-gebruikers welkom als bijdrage aan de documentatie. Of het door trekkingsverzoeken of kwesties, de verbeteringen van de documentatie kunnen correcties, verduidelijkingen, uitbreidingen, en extra voorbeelden zijn.

Documentatienormen

Hoewel wij de bijdragen aan onze documentatie toejuichen, zouden alle bijdragen aan de [!DNL Experience Manager] documentatie, hetzij in de vorm van een trekkingsverzoek of een kwestie, aan onze bijdrage en documentatienormen moeten voldoen.

Bijdragen die niet aan deze normen voldoen, kunnen worden afgewezen.

We documenteren standaardgebruikskwesties

[!DNL Experience Manager] de documentatie heeft betrekking op standaardgebruikstoepassingen. Gebruiksgevallen die buiten het bereik van de standaardinstallatie en het standaardgebruik van het product vallen, maken geen deel uit van de [!DNL Experience Manager]-documentatie.

We documenteren doorgaans geen bugs of de bijbehorende aanraakpunten

[!DNL Experience Manager] de documentatie heeft betrekking op standaardgebruikstoepassingen. Daarom worden bugs, effecten die door bugs worden veroorzaakt en tijdelijke oorzaken voor bugs over het algemeen niet gedocumenteerd.

De uitzonderingen op deze regel zijn op de versienota's van toepassing waar de bekende kwesties met mogelijke oplossingen kunnen worden vermeld die door [!DNL Experience Manager] Productbeheer zijn goedgekeurd.

De bijdragen van de documentatie zijn niet voor het beantwoorden van technische vragen

Eventuele ideeën die u nodig hebt om de [!DNL Experience Manager]-documentatie te verbeteren, zijn welkom als bijdragen. Opmerkingen, problemen en pull-aanvragen zijn echter alleen bedoeld voor bijdragen. Ze zijn niet bedoeld om te worden gebruikt om uw vragen over het gebruik van [!DNL Experience Manager], het implementeren van uw [!DNL Experience Manager]-project of het oplossen van technische problemen te beantwoorden.

Vragen over het gebruik van [!DNL Experience Manager] of technische fouten die u mogelijk hebt gemaakt, moeten via het normale ondersteuningsproces worden gerapporteerd via het [!DNL Experience Manager] ondersteuningsportal of worden besproken in de Experience Manager community.

[!DNL Experience Manager]Documentatiebijdragen zijn geen vervanging voor klantenondersteuning van Adobe en dergelijke bijdragen die antwoorden op supportgerelateerde vragen zoeken, worden afgewezen.

Bijdragen moeten duidelijk verwijzen naar betrokken documentatiepagina's.

Als u een probleem maakt om verbeteringen in de documentatie voor te stellen, moet u koppelingen naar de betrokken pagina's opnemen. Als u een probleemmelding maakt met de koppeling Deze pagina bewerken op een documentatiepagina, wordt de probleemmelding automatisch gemaakt met een koppeling naar de pagina.

Dit is niet van toepassing op terugtrekkingsverzoeken aangezien trekkingsverzoeken door hun aard verwijzen naar de betrokken pagina's.

Documentatierichtlijnen

Wij vragen dat bij alle bijdragen aan onze documentatie bepaalde stijlrichtlijnen worden gevolgd.

Door deze richtlijnen te volgen wordt de revisie van uw bijdrage gemakkelijker en daarom is integratie in onze documentatie sneller.

Taal en stijl

Taal

  • [!DNL Experience Manager] De documentatie wordt ontworpen en gehandhaafd in het Engels van de V.S..
  • Zin zo eenvoudig mogelijk houden.
  • Houd de taal duidelijk en beknopt.

Lezers van [!DNL Experience Manager]-documentatie zijn wereldwijd en kunnen niet verwachten dat ze native of vloeiende Engelstalige luidsprekers zijn. Vermijd colloquialisme en houd de taal zo duidelijk en eenvoudig mogelijk.

Handleiding Microsoft volgen

De Microsoft Manual of Style is een vrij beschikbare documentatiestijlgids die zich richt op softwaredocumentatie en - [!DNL Experience Manager] documentatie en deze gids waar mogelijk volgt.

Opmaak

Item Stijl
UI-element of -optie vet
Bestandsnaam, pad, gebruikersinvoer, parameterwaarden monospaced
Code, opdrachtregel Code Block

Schermpresentaties

Schermopnamen moeten met de nodige voorzichtigheid worden gebruikt en alleen wanneer een tekstbeschrijving niet volstaat.

Markeertekens of andere annotaties in schermafbeeldingen (zoals rode kaders, pijlen of tekst) mogen niet worden gebruikt. Op deze manier zijn de schermafbeeldingen gemakkelijker te hergebruiken of te repliceren in gelokaliseerde versies van de documentatie.

Versiespecifieke verwijzingen

Probeer zo veel mogelijk directe verwijzingen naar een specifieke versie in de documentatie te voorkomen. Dit maakt de documentatie flexibeler en verlengbaar voor toekomstige versies.

Gebruik van Dag, [!DNL Experience Manager], CQ, CRX

Verwijs het product door zijn volledige naam Adobe Experience Manager voor het eerste gebruik in een artikel en verwijs dan naar het als Experience Manager.

Gebruik de termen Dag, Dag Software, CQ en CRX niet, tenzij dit onvermijdelijk is, zoals in klassennamen of verwijzingen naar de geschiedenis van [!DNL Experience Manager].