Kwaliteitscriteria voor de redactionele beoordeling van pull-aanvragen

Deze criteria gelden voor auteurs die technische artikelen schrijven en onderhouden, en voor revisoren van pull-aanvragen die een redactionele beoordeling geven (en geen technische beoordeling) van de inhoudskwaliteit van pull-aanvragen.

Als uw pull-aanvraag niet in aanmerking komt voor automatische invoeging, zal een revisor van pull-aanvragen deze handmatig op inhoudskwaliteit beoordelen. Revisoren van pull-aanvragen beoordelen over het algemeen alleen nieuwe of gewijzigde inhoud. De beoordeling geschiedt volgens de in dit artikel vermelde items voor inhoudskwaliteit waarbij samenvoegingen kunnen worden geblokkeerd en items voor inhoudskwaliteit waarbij dat niet het geval is.

Items voor inhoudskwaliteit waarbij samenvoegingen kunnen worden geblokkeerd

De updates in de pull-aanvraag moeten voldoen aan de volgende criteria om te worden toegevoegd. Revisoren van pull-aanvragen geven in de opmerkingen voor pull-aanvragen feedback over deze items en typen #hold-off in de pull-aanvraag om deze met feedback naar u (de auteur) te retourneren.

Categorie Item voor inhoudskwaliteit
Vereisten Het label 'kan worden toegevoegd' wordt toegewezen aan de pull-aanvraag (gebruik de opmerking #sign-off) en de validatiestatus is 'Goedgekeurd'.
Vereisten Pull-aanvragen voor de livevertakking moeten worden gesloten. De gebruiker moet worden omgeleid naar de hoofdvertakking.
Vereisten De pull-aanvraag kan niet worden geblokkeerd door een samenvoegingsconflict. Als er een samenvoegingsconflict is, kan de gebruiker Resolve simple merge conflicts on GitHub (Eenvoudige samenvoegingsconflicten oplossen in GitHub) raadplegen voor instructies om in de GitHub-gebruikersinterface samenvoegingsconflicten op te lossen. Revisoren van pull-aanvragen lossen conflicten niet op.
Vereisten De opmerking voor de goedkeuring moet worden weergegeven na de validatieresultaten en koppelingen voor tijdelijke opslag. Als de opmerking wordt weergegeven vóór de koppelingen voor tijdelijke opslag, houdt dit in dat de auteur de tijdelijk opgeslagen inhoud niet heeft beoordeeld.
Vereisten Alle artikelen in de pull-aanvraag moeten een Acrolinx-score hebben van 80 of hoger (wanneer Acrolinx is ingeschakeld in de pull-aanvraagwachtrij). Hierop gelden enkele uitzonderingen.
Integriteit van de opslagplaats De pull-aanvraag bevat geen duidelijke inhoudsregressies.
Integriteit van de opslagplaats Bestanden, afbeeldingen of mappen die geen betrekking hebben op het artikel worden toegevoegd aan de hoofdmap van de opslagplaats.
Integriteit van de opslagplaats Pull-aanvragen waarmee een configuratiebestand wordt gewijzigd in de hoofdmap moeten worden beoordeeld en samengevoegd door de beheerder van de opslagplaats.
Integriteit van de opslagplaats De pull-aanvraag heeft geen betrekking op een ingesloten opslagplaats of bevat geen ongebruikelijke, afwijkende bestanden. Alle bestandsupdates moeten zijn beperkt tot de artikelen en Includes-mappen in de opslagplaats. Items waarop u moet letten: .DS_Store, desktop.ini en .gitignore, azure-docs-pr die zijn opgenomen in de hoofdmap.
Integriteit van de opslagplaats De pull-aanvraag bevat minder dan 100 gewijzigde bestanden, tenzij met de pull-aanvraag doelbewust een releasevertakking in de mastervertakking wordt bijgewerkt. (Eigenlijk zou een pull-aanvraag veel minder dan dat aantal moeten bevatten. Na 100 gewijzigde bestanden worden door GitHub echter geen Diff-resultaatgegevens meer weergegeven.)
Integriteit van de opslagplaats Als artikelen worden verwijderd in de pull-aanvraag, moeten deze worden verwijderd door de auteur die wordt vermeld. Wanneer PRMerger wordt uitgevoerd, moeten auteurs die artikelen verwijderen zichzelf als de auteur vermelden in een doorvoering die voorafgaat aan de doorvoering waarmee de artikelen worden verwijderd zodat er geen validatiewaarschuwing wordt gegeven. Op die manier wordt ervoor gezorgd dat verwijderingen doelbewust plaatsvinden.
Integriteit van de opslagplaats Alle verwijderde artikelen worden vergezeld van een vermelding in het hoofdbestand voor de omleiding waarmee deze worden doorgestuurd naar het betreffende nieuwe doel. Als de opslagplaats gebruikmaakt van een hoofdbestand voor de omleiding, wordt bij de omleidingen alleen gebruikgemaakt van de omleidingsmethode voor hoofdbestanden. Omleidingen op basis van bestanden zijn niet toegestaan in opslagplaatsen die gebruikmaken van het omleiden van hoofdbestanden.
Naamgeving Bij bestandsnamen voor nieuwe bestanden worden de richtlijnen voor de naamgeving van bestanden gevolgd.
Naamgeving Bij nieuwe mappen in de opslagplaats worden de richtlijnen voor de naamgeving van mappen gevolgd.
Metagegevens Boven in het bestand bevindt zich de sectie met metagegevens. De sectie met metagegevens begint met drie koppeltekens, gevolgd door een lijst met metagegevens die ten minste title, author, ms.author, ms.date, ms.topic en ms.service of ms.prod bevat en eindigt met drie koppeltekens. In Azure is de waarde services ook vereist.
Metagegevens De waarde voor ms.date kan niet worden ingesteld op een datum die meer dan vijf dagen na de huidige datum valt.
Inhoud Het artikel is een technisch document en bevindt zich daarom in het juiste inhoudskanaal. Bekijk de richtlijnen voor wat waar hoort.
Inhoud Het onderwerp in het technische document is toepasselijk voor een technisch artikel. Bekijk de richtlijnen voor wat waar hoort.
Inhoud Inhoudsopgavebestanden: wanneer er een nieuw artikel wordt toegevoegd, moet tegelijkertijd de inhoudsopgave worden bijgewerkt.
Inhoud Als een indexpagina wordt gewijzigd, moet deze worden gecontroleerd en afgetekend door een aangewezen fiatteur. Kleine aanpassingen op landingspagina's zoals spelfouten verbeteren of koppelingen aanpassen of vervangen hoeven niet te worden goedgekeurd. Voor toevoeging van alle nieuwe inhoud is goedkeuring vereist.
Inhoud Naamregels zijn niet toegestaan. Als in een artikel de naam van de auteur of een inzender wordt vermeld, moet die vermelding worden verwijderd. Artikelen die worden gepubliceerd vanuit de opslagplaats voor technische inhoud worden als door "Microsoft" geschreven artikelen beschouwd. Inzenders die updates voor het artikel hebben doorgevoerd, worden automatisch erkend en vermeld in de balk met inzenders van het gepubliceerde artikel.
Inhoud Het artikel bevat slechts één H1-kop.
Inhoud Het artikel bevat een inleidende alinea en een hoofdtekst met een procedurele of conceptuele verhandeling. De inhoud van het artikel moet voldoende en volledig zijn zodat het artikel op zichzelf kan staan. Het mag geen gedeeltelijke informatie zijn. (Een uitzondering is een onderwerp over limieten als dit plaatsvindt in de context van een groter artikel waarin alle limieten van een service worden vermeld.)
Inhoud Elementen die deel uit moeten maken van een genummerde lijst, krijgen een nummer. Elementen die niet moeten worden gerangschikt, krijgen een opsommingsteken. Dit is een standaardgebruiksvorm.
Inhoud Voor afbeeldingen, indelingen of informatiestructuren die ongebruikelijk of nieuw zijn, of ontwerpen die duidelijk van de standaard afwijken, moet goedkeuring worden gevraagd aan de leidinggevende revisor van pull-aanvragen. Teams die experimenteren met nieuwe dingen moeten beschikken over een canvas of plan voor problemen/oplossingen voor het beoordelen van experimenten.
Inhoud Als een artikel wordt verwijderd, moeten alle kruiskoppelingen naar dat artikel worden verwijderd. Controleer het buildrapport om na te gaan of er geen artikelen zijn die verbroken koppelingen bevatten naar het artikel dat wordt verwijderd.
Functionaliteit van site/ontwerp Schakelaars worden uitsluitend gebruikt om te schakelen tussen meerdere versies van hetzelfde artikel.
Functionaliteit van site/ontwerp Tabbladen in conceptueel artikel (ook wel conceptueel artikel met tabbladen genoemd) is een nieuwe OPS-functie die momenteel niet uitgebreid mag worden gebruikt in technische inhoud voor C+E. Alleen geautoriseerde pilotinhoud mag van de functie voor tabbladen gebruikmaken. Een pull-aanvraag die tabbladen in een conceptueel artikel bevat, moet zonder uitzondering worden goedgekeurd door erifkin. Raadpleeg de conceptrichtlijnen.
Functionaliteit van site/ontwerp De titels van de artikelen waartussen wordt geschakeld, bevatten informatie die elk artikel van de andere artikelen in de reeks onderscheidt.
Functionaliteit van site/ontwerp Handmatig opgestelde inhoudsopgaven zijn niet toegestaan. De inhoudsopgave op de pagina van het artikel moet zijn gebaseerd op H2-koppen.
Functionaliteit van site/ontwerp Als er H2-koppen voorkomen, moet het artikel minstens twee H2-koppen bevatten. Wanneer u één H2-kop gebruikt, wordt er een inhoudsopgave met één item voor het artikel gemaakt. H2-koppen moeten worden gebruikt vóór H3-koppen om ervoor te zorgen dat er een inhoudsopgave wordt gemaakt.
Markdown Broninhoud bevat geen HTML op het blokniveau. Minder ingrijpende inline HTML-opmaak is toegestaan, zoals superscript, subscript, speciale tekens en andere secundaire dingen die je niet met Markdown kunt doen. HTML-tabellen zijn uitsluitend toegestaan als de tabel lijsten met opsommingstekens of genummerde lijsten bevat, maar dat is gewoonlijk een indicatie dat de inhoud moet worden vereenvoudigd zodat de bron kan worden gecodeerd in Markdown.
Markdown Aangepaste Markdown-elementen worden gebruikt wanneer dit van toepassing is. Notities worden bijvoorbeeld gecodeerd met de extensie [!NOTE], niet als tekst zonder opmaak.
SEO De metagegevens voor de titel moeten een merknaam van een product bevatten. In Azure-inhoud moet de titel het woord 'Azure' bevatten. (Artikelen voor Intune, Operations Management Suite [OMS], StorSimple en Cognitive Services zijn uitgezonderd.) Zorg ervoor dat er in andere opslagplaatsen een productnaam voorkomt. De merknaam van een product in de metagegevens voor titleSuffix voldoet ook aan deze vereiste.
SEO De H1-titel bevat voldoende informatie om de inhoud van het artikel te beschrijven, het artikel te onderscheiden van andere artikelen in de inhoudsreeks en de titel te koppelen aan waarschijnlijke zoekwoorden van de klant. Wanneer u bijvoorbeeld 'Overzicht' gebruikt als de H1-titel, is dit een zeer algemene titel die geen nuttige informatie bevat voor een klant of zoekopdracht.
Terminologie Het gebruik van het ARM-acroniem of V1 of V2 als verwijzing naar het klassieke implementatiemodel en het Resource Manager-implementatiemodel in Azure is een blokkerend terminologie-item.
Afbeeldingen GIF-animaties en PDN-bestanden worden niet geaccepteerd in de opslagplaats.
Afbeeldingen De afbeeldingen hebben een duidelijke resolutie, bevatten geen woorden met spelfouten en geen privégegevens.
Lokaliseerbaarheid Koppelingen naar pagina's op azure.microsoft.com, TechNet en MSDN zijn gecodeerd voor een specifieke landinstelling. Gebruik geen landinstellingen als nl-nl en nl-be in koppelingen naar deze sites. TechNet/MSDN-forumkoppelingen vormen een uitzondering: landinstellingen kunnen niet worden verwijderd uit de forumkoppelingen op deze sites.
Tijdelijke opslag Het voorbeeld voor het artikel mag geen fouten bevatten wanneer het tijdelijk wordt opgeslagen. Er mogen geen duidelijke problemen met de opmaak zijn:
- Een genummerde lijst of lijst met opsommingstekens die wordt weergegeven als een alinea
- Code in een codeblok die gedeeltelijk in het codeblok en gedeeltelijk daarbuiten wordt weergegeven
- Genummerde stappen die onjuist zijn genummerd vanwege een verkeerde inspringing
- Markeringen voor samenvoegingsconflicten die zijn blijven staan

Items voor inhoudskwaliteit waarbij de samenvoeging niet kan worden geblokkeerd

Voor deze items geven de revisoren van pull-aanvragen feedback en instructies voor de auteur die door deze kunnen worden verwerkt in een volgende pull-aanvraag. Met deze feedback wordt de samenvoeging echter niet geblokkeerd. Auteurs moeten de feedback binnen drie werkdagen verwerken.

Categorie Item voor inhoudskwaliteit
Inhoud Artikelen moeten afsluiten met een gedeelte Volgende stappen waarin één tot drie relevante en gefundeerde volgende stappen worden vermeld. In een korte begeleidende tekst geeft u voor de klant aan waarom de volgende stappen relevant zijn. (Deze regel geldt alleen voor nieuwe artikelen.) Bijvoorbeeld:
Voorbeeld van het gedeelte "Volgende stappen"
Inhoud Revisoren van pull-aanvragen kunnen feedback geven over enkele kleine problemen met betrekking tot spelling, grammatica en andere schrijfproblemen zonder dat de samenvoeging wordt geblokkeerd. Als het aantal redactionele problemen oploopt, plaatsen de revisoren een bewerkingsaanvraag voor het artikel zodat het na de publicatie wordt bewerkt.
Afbeeldingen Voor afbeeldingen worden de juiste stijl en kleur gebruikt voor markeringen en voor schermafbeeldingen worden de juiste randstijl en stijl voor plaatselijke aanduidingen gebruikt. Raadpleeg de richtlijnen voor afbeeldingen.
Afbeeldingen De afbeeldingen omvatten alternatieve tekst. Raadpleeg de richtlijnen voor afbeeldingen.
Functionaliteit van site/ontwerp De H2-koppen beslaan idealiter niet meer dan twee regels wanneer ze in de inhoudsopgave op de pagina worden weergegeven. Wanneer koppen meer tekst bevatten, is de inhoudsopgave van het artikel moeilijker te scannen.
Stijlconventies Alle titels en koppen volgen het hoofdlettergebruik voor zinnen, volgens de Azure-stijl.
Procedure Als de pull-aanvraag eenvoudig had kunnen worden aangepast om met PRMerger automatisch te worden samengevoegd, geven revisoren van pull-aanvragen feedback aan de auteur waarin ze uitleggen hoe vertakkingen kunnen worden gebruikt zodat de wijzigingen automatisch kunnen worden samengevoegd. Raadpleeg het artikel over aanbevolen procedures voor pull-aanvragen.

PR's die de opslagplaatsbeheerder moet controleren en samenvoegen

  • Updates van configuratiebestanden
  • PR's die betrekking hebben op meer dan 100 bestanden