Updates pengalaman dokumentasi PowerShell kami

Posting ini ditulis oleh Jeff Sandquist, General Manager di tim Azure Growth and Ecosystem.

Hari ini kami meluncurkan pengalaman Azure PowerShell kami yang telah dirubah untuk docs.microsoft.com. Peningkatan pengalaman ini termasuk penerapan versi modul, penyorotan sintaks kode, daftar isi yang lebih mudah dinavigasi, kemampuan untuk mengedit dan meningkatkan dokumen, dan banyak lagi. Kami tahu dari umpan balik pelanggan bahwa konten PowerShell telah menjadi area untuk peningkatan dan ini adalah langkah berikutnya dalam perjalanan kami untuk meningkatkan kualitas konten kami. Kami telah mulai dengan Azure, tetapi akan memindahkan semua konten PowerShell kami ke pengalaman ini dalam beberapa bulan mendatang.

Referensi Modul PowerShell Terpadu

Tujuan dari dokumen referensi Modul PowerShell kami adalah untuk memberikan pengalaman terpadu untuk semua modul PowerShell yang dikirimkan di Microsoft. Ini termasuk:

• Pola URL yang Konsisten - Jika Anda mengetahui nama modul atau cmdlet, Anda tahu URL-nya. Pola URL yang kami gunakan di Dokumen adalah: docs.microsoft.com/powershell/module/{module-name}/{cmdlet-name}/. Untuk cmdlet Get-AzureRMStorageAccount yang ada di modul AzureRM.Storage , URL-nya adalah: https://docs.microsoft.com/powershell/module/azurerm.storage/get-azurermstorageaccount
• Pengalaman pengguna yang konsisten - Pemformatan untuk modul, cmdlet, dan sampel sekarang sama di seluruh pengalaman dokumentasi PowerShell.
• Kontribusi mudah - Pengguna PowerShell dapat menambahkan sampel kode atau mengedit dokumen referensi kami dengan mengklik tombol Edit langsung di halaman dokumen.
• Dukungan untuk penerapan versi untuk versi PowerShell sebelumnya - Untuk memfilter versi Azure PowerShell tertentu, gunakan pemilih versi dalam halaman kami.

Penerapan Versi PowerShell

Meskipun kami menyebutkan penerapan versi untuk modul tertentu, beberapa modul dikirim sebagai sekelompok modul lain, masing-masing dengan skema penerapan versi terpisah mereka sendiri. Misalnya, pelanggan mengunduh Azure PowerShell melalui PowerShellGet. Di masa lalu pelanggan harus menguraikan secara manual versi dokumen mana yang berlaku untuk penginstalan mereka. Misalnya, jika Anda menginstal Azure PowerShell 3.7, Anda harus mengetahui setiap modul individual yang dikirim AzureRM 3.7 dengan AzureRM.Automation 2.7 dan AzureRM.CognitiveServices v0.5.0 dan mencari dokumen tersebut.

Dengan pengalaman baru kami, Anda hanya memiliki satu versi untuk dipilih dan kami akan memfilter modul yang benar berdasarkan apa yang telah Anda instal.

Daftar isi yang disempurnakan

Selain referensi cmdlet, kami menambahkan konten gambaran umum, langkah-langkah penginstalan, memulai, dan sampel. Untuk referensi Azure, kami juga mengelompokkan cmdlet berdasarkan Azure Service.

Filter dengan mudah saat Anda mengetik - dari daftar isi

Anda dapat dengan mudah memfilter DAFTAR ISI kiri saat mengetik untuk cmdlet atau layanan yang cocok dengan nama tersebut.

Penyempurnaan halaman cmdlet

Pewarnaan dan pemformatan yang disempurnakan

Cmdlet PowerShell sekarang diwarnai dengan baik dan diformat untuk keterbacaan yang lebih baik.

Penyempurnaan parameter

Meskipun sebelumnya kami mengelompokkan parameter berdasarkan apakah parameter tersebut diperlukan atau opsional, daftar parameter muncul tidak diurutkan. Sebagai gantinya, kami menambahkan judul bagian untuk mengelompokkan parameter yang diperlukan dan parameter opsional dan meningkatkan pewarnaan/gaya untuk nama parameter.

Perilaku Salin/Tempel yang Lebih Cerdas

Sejumlah sampel kode cmdlet PowerShell kami diawali dengan teks PS C:\>. Saat Anda mengklik tombol Salin untuk contoh kode, kami sekarang akan menghapus awalan PS C:\> , seperti yang ditunjukkan pada cuplikan layar Notepad di bawah ini.

Umpan Balik Anda

Kami berharap Anda melihat peningkatan signifikan dengan rilis ini.