| source-git-commit | workflow-type | source-wordcount | ht-degree |
|---|---|---|---|
0f3a2cb6deacd0a81db8f0dc2b1554e7506aaf17 |
tm+mt |
714 |
0% |
Adobe Experience Manager-gebruikers werken in zeer concurrerende omgevingen en streven ernaar om digitale ervaringen te creëren die hen onderscheiden van hun concurrenten. Wanneer de Adobe geavanceerde hulpmiddelen in AEM levert, worden deze hulpmiddelen daarom aangevuld met nauwkeurige en duidelijke documentatie. Het laat klanten onmiddellijk hun AEM investering gebruiken en hun rendement van investering maximaliseren.
Het doel van de AEM is zo snel mogelijk documentatie in de handen van AEM gebruikers te plaatsen. Daarom geeft de Adobe prioriteit aan nauwkeurige, bruikbare documentatie en wordt ernaar gestreefd deze voortdurend bij te werken en te verbeteren.
Met het oog op de voortdurende verbetering van AEM documentatie is de hele gemeenschap van AEM gebruikers welkom om bij te dragen aan de documentatie. Of het door trekkingsverzoeken of kwesties, de verbeteringen van de documentatie kunnen correcties, verduidelijkingen, uitbreidingen, en andere voorbeelden zijn.
Hoewel de Adobe de bijdragen aan haar documentatie toejuicht, moet elke bijdrage aan de AEM documentatie in een pull-verzoek of een kwestie in overeenstemming zijn met de bijdrage- en documentatienormen van de Adobe.
Bijdragen die niet aan deze normen voldoen, kunnen worden afgewezen.
AEM documentatie behandelt standaardgebruikscenario's. Gebruiksgevallen die buiten het bereik van de standaardinstallatie en het standaardgebruik van het product vallen, maken geen deel uit van AEM documentatie.
AEM documentatie behandelt standaardgebruikscenario's. Daarom zijn bugs, effecten die door bugs worden veroorzaakt en werkargumenten voor bugs 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 het Beheer van het Product hebben goedgekeurd.
Alle ideeën die u nodig hebt om AEM documentatie te verbeteren, zijn welkom als bijdragen. Opmerkingen, problemen en intrekkingsverzoeken zijn echter bedoeld als bijdragen alleen. Ze moeten geen antwoord geven op uw vragen over het gebruik van AEM, het implementeren van uw AEM-project of het oplossen van technische problemen.
U kunt om het even welke vragen over AEM gebruik of technische fouten melden. Gebruik het normale ondersteuningsproces als Enterprise Support-portal van Experience Cloud of in de Experience Manager.
AEM documentatiebijdragen zijn geen vervanging voor de klantenservice van de Adobe en dergelijke bijdragen die vragen om antwoorden op ondersteunende vragen worden afgewezen.
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 uitgave maakt met de Deze pagina bewerken op een documentatiepagina wordt de uitgave automatisch gemaakt met een koppeling naar de pagina.
Dit proces is niet van toepassing op trekkingsverzoeken omdat trekkingsverzoeken van nature verwijzen naar de betrokken pagina's.
Adobe vraagt dat bijdragen aan haar documentatie bepaalde stijlrichtlijnen volgen.
Met deze richtlijnen wordt de beoordeling van uw bijdrage eenvoudiger en wordt uw bijdrage sneller in de documentatie van de Adobe opgenomen.
- AEM documentatie is geschreven en onderhouden in het Engels van de VS.
- Zin zo eenvoudig mogelijk houden.
- Houd de taal duidelijk en beknopt.
Alle lezers van AEM 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.
De Microsoft®-handleiding is een vrij beschikbare gids van de documentatiestijl die zich op softwaredocumentatie en AEM documentatie concentreert waar mogelijk deze gids volgt.
| Item | Stijl |
|---|---|
| UI-element of -optie | vet |
| Bestandsnaam, pad, gebruikersinvoer, parameterwaarden | monospaced |
| Code, opdrachtregel | Code Block |
Schermafbeeldingen 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 in gelokaliseerde versies van de documentatie te herhalen.
Probeer zo veel mogelijk directe verwijzingen naar een specifieke versie in de documentatie te voorkomen. Deze aanbeveling maakt de documentatie flexibeler en uitbreidbaar voor toekomstige versies.
Verwijs in een artikel altijd naar het product met de volledige naam Adobe Experience Manager de eerste keer dat het wordt gebruikt. Daarna kan worden verwezen naar AEM.
De software van de dag, de Dag, CQ, en CRX zouden niet moeten worden gebruikt behalve waar onvermijdbaar zoals in klassennamen of verwijzend naar de geschiedenis van AEM.