Medewerkershandleiding voor Adobe-documentatie
In deze handleiding wordt beschreven hoe u een bijdrage kunt leveren aan de Adobe Enterprise Help op Experience League.
Wat is documentatie voor samenwerking?
De technische documentatie en enablement inhoud voor Adobe Experience Cloud en andere producten van de Onderneming van Adobe zijn gebaseerd op open bronprincipes die de oplossingen GitHub, Markdown, en van Adobe Experience Cloud gebruiken.
Dit open-sourcemodel verbetert de kwaliteit van de inhoud en de communicatie tussen klanten, documentatieteams en productteams. Op elke pagina kunt u nu het nut van inhoud beoordelen, problemen met het logbestand bekijken en zelfs inhoudssuggesties leveren als Git pull-aanvragen (PR’s). De Adobe-documentatieteams houden dagelijks toezicht op de bijdragen en problemen en voeren zo nodig updates, bijstellingen en aanpassingen uit.
Werken met documentatie voor samenwerken
Als gebruiker van dit materiaal - ongeacht als u een werknemer, een partner, een klant of zelfs potentiële klanten bent - hebt u de keus om aan deze documentatie op verscheidene eenvoudige manieren bij te dragen.
- De bruikbaarheid van de pagina beoordelen ❶ en een optionele opmerking schrijven ❷
- Een probleem rapporteren op een specifieke pagina (vereist aanmelding bij it) ❸
- Breng een snelle bewerking door naar het ontwerpen van volledige artikelen, compleet met elementen en codevoorbeelden (vereist aanmeldingsgegevens voor Git) ❹
Deze opties worden een paar seconden na het openen onder aan de pagina weergegeven. Als u het feedbackgebied sluit, kunt u de pagina opnieuw laden om deze terug te halen.
In deze handleiding wordt beschreven wat u moet weten om te communiceren met en bij te dragen aan deze materiaalset.
De bruikbaarheid van de pagina beoordelen en een opmerking schrijven
Een paar seconden nadat u een pagina hebt geopend, wordt onder aan de pagina een feedbackgebied weergegeven. Klik omhoog of omlaag om aan te geven of de pagina nuttig was.
Voel u vrij om een opmerking te geven voor extra feedback.
Snelle bewerkingen uitvoeren op bestaande documenten
Als u gedetailleerdere feedback wilt geven, kunt u met behulp van snelle bewerkingen kleine fouten en weglatingen in documenten corrigeren. When you suggest an edit, you submit a pull request (PR) to submit the fix/suggestion to us, and we can vet, approve, and publish the suggestion.
-
Sign the Contributor License Agreement (CLA) if acceptable.
You only need to submit an Adobe CLA one time.
-
In the feedback area that appears at the bottom of the article, click Detailed feedback options, and then click Suggest an edit to go to the markdown source file on GitHub.
-
Click the pencil icon to edit the article.
note NOTE If the pencil icon is grayed out, you need to login to your GitHub account, or create a new account. -
Make your changes in the web editor.
U kunt op de tab Preview changes klikken om de opmaak van de wijziging te controleren.
-
After you make your changes, scroll to the bottom of the page.
Enter a title and description for your PR, then click Propose file change as shown in the following figure:
note NOTE If you get a validation error message about signing a Contributor License Agreement (CLA), click Details to open the license agreement. Sign the agreement, if acceptable. Vervolgens sluit u het verzoek en opent u het verzoek en gaat u verder.
That’s all there is to it. Documentation team members will review and merge your pull request. Thank you!
Report an issue
Another easy way to let us know about a problem with a piece of content is to use Report an issue.
-
In the feedback area that appears at the bottom of the article, click Detailed feedback options, and then click Report an issue to go to the markdown source file on GitHub.
note NOTE To report an issue, you must log in to your GitHub account, or create an account. Clicking this link allows you to log a quick ticket with Experience League, using the Github Issue interface.
De URL van de pagina met de uitgave wordt automatisch ingevuld in het beschrijvingsveld.
-
Vul de titel in, schrijf een korte beschrijving van de kwestie, en klik dan voorleggen nieuwe kwestie.
Als u een uitgave verzendt, wordt het inhoudsteam op de hoogte gebracht van deze pagina, die uw probleem kan verhelpen. Als we de inhoud hebben bijgewerkt, geven we dit via de interface Github Issues door en sturen we u een e-mail wanneer deze wordt bijgewerkt of gesloten.
GitHub-machtigingen begrijpen
De GitHub die UI uitgeeft past aan uw bewaarplaatstoestemmingen aan. De voorgaande afbeeldingen zijn accuraat voor contribuanten die geen schrijfmachtigingen hebben voor de doelopslagplaats. GitHub leidt automatisch tot een vork van de doelbewaarplaats in uw rekening. Als u toegang tot de doelbewaarplaats hebt schrijven, leidt GitHub tot een nieuwe tak in de doelrepo.
Adobe gebruikt trekkingsverzoeken voor alle wijzigingen, zelfs voor contribuanten die schrijftoegang hebben. De meeste repositories hebben de main -vertakking beveiligd, zodat updates moeten worden verzonden als pull-aanvragen.
De bewerkervaring in de browser is het meest geschikt voor kleine of niet-frequente wijzigingen. Als u grote bijdragen maakt, of de geavanceerde eigenschappen van het Git gebruikt, adviseren wij dat u de repo en het werk plaatselijk fork.
Feedback geven
Als een oplossing zo groot is als Adobe, wordt de documentatie altijd uitgevoerd. Als u fouten ontdekt, registreer een kwestie, als u suggesties op materiaal hebt te vertellen gelieve ons. Vertel ons welke informatie u zocht. Laat ons weten of u niet kon vinden wat u nodig had, of als u moeite had om uw taak te voltooien, gelieve ons te vertellen hoe wij u kunnen helpen onze oplossingen leren.
Dank u van het Collaborative Documentation team en alle schrijvers en inhoudsproducenten in Experience League. Bedankt voor je hulp.