November update voor docs.microsoft.com

Artikel
09/15/2023

Dit bericht is geschreven door Jess Sandquist, General Manager in de Cloud + Enterprise-divisie.

Vandaag kondigen we met trots aan dat we nu de documentatie voor Azure, Visual Studio 2017 RC, C++, ASP.NET Core, Entity Framework Core en SQL op Linux hebben gemigreerd naar docs.microsoft.com.

Door alle inhoud op één plek te verzamelen, zorgen we voor een consistentere gebruikservaring voor onze klanten, voor mobiele ondersteuning, lokalisatie, opmerkingen, sociaal delen en bijdragen van de community.

Ondanks dat dit een grote release is, blijven we de inhoud en functionaliteit op de site regelmatig bijwerken, dus blijf ons vooral UserVoice-feedback sturen over uw ervaringen.

Verder zullen we de komende maanden inhoud toevoegen over Dynamics 365, Windows Server, SQL Server, System Center en Windows Desktop.

In dit bericht

Belangrijke functies van Docs
Nieuwe functies van Docs
Azure-documentatie
Documentatie voor Visual Studio 2017 RC
Documentatie voor C++
Documentatie voor ASP.NET Core
Documentatie voor Entity Framework Core
Documentatie voor SQL op Linux

Belangrijke functies van Docs

Voor degenen die niet bekend zijn met docs.microsoft.com volgen hier een paar van de belangrijkste functies van de nieuwe ervaring.

Geschatte leestijd en Laatst bijgewerkt

Een eenvoudige verbetering die we hebben aangebracht op basis van uw invoer, is het opgeven van een geschatte leestijd voor een artikel. We weten dat velen van u technologieën leren en evalueren in die paar minuten tussen vergaderingen en dat u meer kans hebt om artikelen te lezen als u wist hoeveel tijd er nodig is.

Daarnaast hebben we tijdstempels toegevoegd zodat u kunt zien hoe nieuw de inhoud is, en niet langer hoeft te gissen naar wanneer een artikel voor het laatst is bijgewerkt.

Responsief ontwerp

We zijn overgestapt op een responsieve indeling om een uitmuntende ervaring te kunnen bieden voor mobiele apparaten, tablets en pc's. Als u op een apparaat met een klein scherm klikt op de knop Opties bovenaan het scherm, krijgt u dezelfde opties te zien als in een bureaubladbrowser.

Wereldwijde documentatie

We horen regelmatig van internationale klanten dat zij veel belang hechten aan gelokaliseerde inhoud. docs.microsoft.com is nu beschikbaar in 45 talen, inclusief een aantal rechts-naar-links-talen zoals Arabisch en Hebreeuws, en 63 landinstellingen voor Dynamics 365-inhoud, met terugvallogica voor wanneer gelokaliseerde documenten niet beschikbaar zijn. We bieden nu dus documentatie voor de echt hele wereld, documentatie die klaar is voor de nieuwe inhoud van het komende jaar.

Kantlijnnotities en opmerkingen

We vinden uw vragen, opmerkingen en feedback belangrijk. We werken samen met Livefyre om opmerkingen en opmerkingen bij al onze artikelen te maken. Boven aan elk artikel ziet u een optie om rechtstreeks naar de sectie opmerkingen te gaan.

We horen graag van u, en lezen en reageren op alle opmerkingen en vragen die op Docs-pagina's worden geplaatst.

Als u een opmerking wilt plaatsen, kunt u zich aanmelden met uw referenties voor uw account bij Twitter, Facebook, Google, Yahoo of Microsoft.

Daarnaast kunt u de threads volgen waarin u reacties verwacht, zodat u altijd weet wanneer iemand van ons team of een van de communityleden reageert.

U kunt kantlijnnotities ook toevoegen aan elke alinea met inhoud of aan speciaal geselecteerde inhoud. Hiervoor selecteert u tekst met de muis en klik u op het pictogram voor opmerkingen dat aan de rechterkant van de alinea wordt weergegeven wanneer u de aanwijzer erboven houdt.

Met de knop voor delen boven aan de pagina kunt u de inhoud eenvoudig delen met uw volgers op Twitter en vrienden op Facebook.

U kunt inhoud ook rechtstreeks selecteren met de muis en delen via de contextuele widget.

Licht/donker thema

We hebben ook een themakiezer toegevoegd, zodat u kunt schakelen tussen een licht en een donker thema, iets dat sommigen van u hebben [asked for on UserVoice](https://msdocs.uservoice.com/forums/364242-general-site-feedback/suggestions/14999211-komplete-dark-theme).

Beschrijvende URL's

We vinden een goede webervaring belangrijk en één ding dat ons regelmatig dwarszat wanneer we TechNet en MSDN gebruikten, was dat artikelen geen beschrijvende, leesbare URL's hadden. Hier volgt een voorbeeld van hetzelfde artikel met onze nieuwe URL's.

Voor

https://technet.microsoft.com/library/dn646983.aspx3

Na

https://docs.microsoft.com/intune/get-started/start-with-a-paid-subscription-to-microsoft-intune

Bijdragen van de community

Het overgrote merendeel van de documentatie op onze site is geschikt voor bijdragen van de community. U hoeft slechts te klikken op de knop Bewerken in het menu rechtsboven om naar de bijbehorende GitHub-pagina te gaan, een splitsing te maken in de documentenopslagplaats, een wijziging aan te brengen en uw pull-aanvraag in te dienen. We zijn ook blij met uw bewerkingen van gelokaliseerde inhoud en feedback over de gebruikerservaring voor bijdragen!

Nieuwe functies van Docs

Hoewel veel van deze functies als sinds de lancering in mei beschikbaar zijn, hebben we ook een aantal nieuwe functies toegevoegd, die hieronder worden beschreven.

Realtimefilter voor de inhoudsopgave

We hebben onze inhoudsopgave direct filterbaar gemaakt. Dit houdt in dat u slechts een paar tekens hoeft te typen om direct te filteren op overeenkomende tekst en de inhoud kunt vinden die u zoekt.

Een andere belangrijke functie die we hebben toegevoegd betreft het probleem van inhoud op meerdere sites. Moet een artikel over het implementeren van ASP.NET op Azure App Service worden vermeld onder Azure of ASP.NET? Het moet onder beide worden vermeld, maar zonder dat dezelfde inhoud in beide secties wordt geplaatst, omwille van vindbaarheid en consistentie.

Daarom hebben we het mogelijk gemaakt voor inhoudsteams om inhoud op docs te selecteren en een weergave van die inhoud te maken voor klanten. In de onderstaande afbeelding is een hypothetische indeling te zien voor .NET-ontwikkelaars met Docker, die inhoud bevat die afkomstig is van de teams voor Azure, ASP.NET, .NET Core en Visual Studio Azure SDK - allemaal in één weergave.

Controleerbare codevoorbeelden

Een van de meest frustrerende aspecten van documentatie is dat gepresenteerde of gekoppelde voorbeelden niet werken op uw machine. Microsoft heeft duizenden codevoorbeelden en codefragmenten, en we willen dat onze klanten erop kunnen vertrouwen dat die voorbeelden werken op de ondersteunde platformen en configuraties.

Om die reden hebben we een uitbreidbaar systeem voor continue integratie (CI) ontwikkeld, dat ervoor zorgt dat de voorbeelden kunnen worden gecompileerd en de verwachte uitvoer leveren met een bepaalde set besturingssystemen en hulpprogrammaketens. We zijn bezig om meer teams hierop voor te bereiden, maar we willen dat gebruikers die onze code downloaden, erop kunnen vertrouwen dat die alle noodzakelijke kwaliteitscontroles heeft doorstaan.

Geïntegreerd referentiemateriaal

We hebben de onderliggende DocFX-engine, het opensourceonderdeel waarop docs.microsoft.com draait, opnieuw ontworpen voor taalbindingen voor verschillende platformen en indelingen. Dit biedt ondersteuning voor:

Azure CLI (Python)
PowerShell
.NET en .NET Core
Java
Swagger / REST-API's

Voor klanten betekent dit dat de documentatie niet langer verschuift maar gelijke tred houdt met de API-mogelijkheden, omdat er nu één bron is voor zowel de documentatie als de code. U kunt meer lezen over de specifieke ondersteuning voor API-verwijzing in de secties Azure en ASP.NET/EF hieronder.

PDF-ondersteuning

Een andere belangrijke functie waarom onze klanten vroegen is ondersteuning voor PDF. U kunt een specifieke set documentatie downloaden zonder dat die gigabytes aan opslagruimte in beslag neemt, en die documentatie overal raadplegen - zowel op een pc als op een mobiel apparaat.

Daarvoor hebben we ondersteuning voor PDF ingeschakeld voor onze inhoudsopgave. We hebben ervoor gezorgd dat het PDF-bestand wordt bijgewerkt zodra de inhoud op de actieve site wordt bijgewerkt, zodat u altijd over de nieuwste inhoud beschikt.

<img alt="screenshot16]()

Azure-documentatie

We hebben geluisterd naar uw feedback over fragmentatie en uitdagingen met betrekking tot de ervaring, dus we zijn goed op weg om onze technische documentatie van Azure te migreren van azure.microsoft.com, MSDN en GitHub en deze te consolideren op https://docs.microsoft.com/azure/.

Nieuwe Azure Hub-pagina

We hebben ook van de gelegenheid gebruikgemaakt om het uiterlijk van de startpagina voor Azure-inhoud te wijzigen. Een aantal belangrijke wijzigingen zijn:

Een tabblad Services waarop de Azure-services per categorie worden gegroepeerd.
Een tabblad Ontwikkelaar waarop al het Azure-referentiemateriaal voor REST-API, Azure .NET SDK, Azure Java SDK, Azure CLI en Azure PowerShell wordt vermeld.
Een tabblad Architectuur met informatie over ontwerppatronen voor cloudomgevingen voor architecten en ontwikkelaars.

Nieuwe servicepagina

Onze startpagina's zijn consistent en bieden koppelingen naar belangrijke bronnen, zoals:

Een koppeling Serviceoverzicht.
Aan de slag-zelfstudies voor alle relevante platformen en programmeertalen.
Een koppeling naar alle videozelfstudies voor een bepaalde service.
Koppelingen naar referentiemateriaal over API's.
Een koppeling voor het downloaden van alle documentatie voor de service.

Nieuwe inhoudsopgave

Met de overgang naar docs.microsoft.com/azure zorgen we meteen voor een betere consistentie bij het navigeren door de inhoudsopgave. Ondanks dat elke service unieke kenmerken heeft, werkt de navigatie nu hetzelfde op de hele site.

Verbeterde inkleuring

Voor codevoorbeelden van de Azure-opdrachtregelinterface (CLI) hebben we trefwoorden en parameters een kleur gegeven, zodat u de code gemakkelijker kunt lezen en begrijpen.

Verbeterde verwijzingen

Een van de grootste problemen die u bij ons onder de aandacht hebt gebracht, is dat onze inhoud over API, opdrachtregels en PowerShell nooit actueel is. Azure verandert zo snel dat onze oude handmatige werkstromen niet meer werken.

Voor deze versie hebben het systeem gewijzigd, zodat er direct referentiemateriaal wordt gemaakt op basis van de broncode. Nieuwe inhoud wordt geleverd tegelijk met een nieuwe build. En net zoals u kunt bijdragen aan de inhoud van een Procedure, kunt u dat ook bij het automatisch gegeneerde deel van de documentatie.

Daarnaast zijn we bezig met het standaardiseren van het gebruik van de Open API-specificatie (voorheen Swagger) om onze REST-API's te beschrijven. Hiermee beschikken we over een consistente gegevensweergave voor REST-services, die we kunnen gebruiken voor documentatie en voor client-SDK's. In de toekomst zullen we interactieve functies en voorbeelden van aanvraag/antwoord-nettoladingen kunnen toevoegen aan onze REST-documentatie.

Voor deze versie hebben we het volgende ingeschakeld:

Documentatie voor Visual Studio 2017 RC

Alle documentatie voor Visual Studio wordt rechtstreeks geïntegreerd in het nieuwe en bijgewerkte docs.microsoft.com.

Nieuwe Visual Studio Hub-pagina

De Visual Studio Hub-pagina bevat belangrijke koppelingen om aan de slag te gaan met de Release Candidate van Visual Studio 2017.

Deze omvatten de zelfstudies Installatiehandleiding, Wat is er nieuw en Aan de slag. Gelokaliseerde inhoud volgt binnenkort. Er komt nieuwe inhoud beschikbaar voor onderwerpen zoals herstructurering, het werken met code buiten een project, het oplossen van prestatieproblemen, tips voor het geoptimaliseerd opstarten van Visual Studio, details over alle nieuwe functies voor productiviteit en codenavigatie in de editor, en nog veel meer.

Doordat Visual Studio nu ondersteuning biedt voor een geheel aanpasbaar installatieproces, waarmee u alleen de onderdelen krijgt die u wilt gebruiken, kunt u meer informatie krijgen over hoe dit werkt voor uw specifieke ontwikkelingsprojecten, ongeacht of uw werkbelastingen betrekking hebben op een ASP.NET, Azure, Python of Windows-platform.

Documentatie voor ASP.NET en Entity Framework Core

De documentatie voor ASP.NET Core en Entity Framework Core zijn ook gemigreerd van respectievelijk docs.asp.net en GitHub.

Referentiemateriaal ASP.NET/Entity Framework

Omdat ASP.NET en Entity Framework Core opensourceprojecten zijn, hebben we de broncodes en opmerkingen met drie slashes vergaand geïntegreerd voor het opbouwen van de documentatie voor de respectieve API-verwijzing. Dit betekent dat de API en de documentatie altijd automatisch synchroon lopen.

Documentatie voor C++

In antwoord op terugkerende verzoeken van klanten hebben we het referentiemateriaal voor C++ geherstructureerd naar een compactere indeling, waarvoor minder koppelingen tussen onderwerpen nodig zijn. U vindt nu alle documentatie voor klassenleden in hetzelfde onderwerp als voor de klasse.

Daarnaast krijgt u meer informatie over de meest recente wijzigingen in de manier waarop C++ aan de standaarden voldoet en nieuwe bouwopties zoals /fastlink. Ook kunt u gebruikmaken van de nieuwe richtlijnen voor overzetten om uw code uit de vorige versies van Visual Studio te upgraden, en ontdekken hoe u de nieuwe ondersteuning voor het bouwen op Linux-systemen met gcc kunt uitproberen.

Documentatie voor SQL op Linux

SQL Server op Linux (onderdeel van de Customer Technical Preview 1 van SQL Server vNext) is klaar om te worden uitgeprobeerd! De Hub-pagina biedt belangrijke koppelingen voor het aan de slag gaan en ontwikkelen met SQL Server op Linux. Gelokaliseerde inhoud volgt binnenkort.

Conclusies

We bieden graag nog meer functies op de nieuwe documentatiesite, om ervoor te zorgen dat de gebruikservaring overeenkomt met die van onze producten en services. Omdat u, de gebruiker, het meest kritieke onderdeel in het documentatieproces bent, raden we u aan contact met ons op te stellen en feedback te geven over hoe we deze ervaring voor u kunnen verbeteren op Twitter.

November update voor docs.microsoft.com

In dit bericht