Mengumumkan pengalaman referensi .NET terpadu di docs.microsoft.com
Posting ini ditulis oleh Jeff Sandquist, General Manager di tim Azure Growth and Ecosystem.
Hampir setahun yang lalu, kami menguji coba dokumentasi referensi .NET Core tentang docs.microsoft.com. Hari ini kami dengan senang hati mengumumkan pengalaman referensi .NET API terpadu kami. Kami memahami bahwa produktivitas pengembang adalah kunci - dari pengembang hobi, hingga startup, hingga perusahaan. Dengan mengingat hal tersebut, kami bermitra erat dengan tim Xamarin untuk menstandarkan cara kami mendokumen, menemukan, dan menavigasi API .NET di Microsoft.
Semua dokumentasi .NET - di satu tempat
Sebelumnya, jika Anda ingin menemukan . SDK berbasis NET yang dikirim oleh Microsoft, Anda harus menghabiskan waktu dengan mesin pencari favorit Anda, mencoba menemukan kedua tempat di mana Anda dapat mengunduhnya, serta menemukan dokumentasi API yang relevan.
Ke depannya, kami berencana untuk memiliki semua . SDK yang kompatibel dengan NET terpadu dan dapat dicari di satu tempat: https://docs.microsoft.com/dotnet/api. Di sana, Anda akan menemukan dokumentasi referensi untuk .NET Framework, .NET Core, .NET Standard dan Xamarin, serta dokumentasi untuk paket Azure NuGet kami. Pada bulan-bulan mendatang, kita akan menambahkan lebih banyak SDK ke pengalaman ini.
Memperkenalkan Browser API
Tujuan utama kami adalah menghadirkan pengalaman seperti IntelliSense untuk mencari semua API .NET dari browser web. Anda dapat mencari namespace, kelas, metode, atau antarmuka dengan mengetikkan nama lengkap atau sebagiannya langsung di halaman Browser API.
Jika Anda tidak yakin SDK mana yang dimiliki oleh jenis, anggota, atau namespace tertentu, Anda cukup memilih Semua API di menu dropdown cakupan API dan mencari di semua dokumen referensi yang tersedia. Atau, jika Anda ingin membatasi pencarian, Anda dapat memilih kerangka kerja atau SDK tertentu serta versinya - misalnya, .NET Framework 4.7, dan hanya mencari dalam kumpulan API tersebut.
Pengalaman Browser API juga terintegrasi di bagian atas daftar isi untuk . API berbasis NET, memungkinkan Anda menemukan API dengan cepat di mana pun Anda berada dalam dokumentasi referensi:
Setelah Anda berada di namespace tertentu, Browser API hanya dilingkupkan ke keluarga API yang terhubung bersama-sama, sehingga pencarian Anda selalu mengembalikan hasil terbaik berdasarkan konteks Anda.
Dukungan Penerapan Versi
Anda tidak perlu lagi bertanya-tanya apakah jenis memiliki anggota yang tersedia dalam versi .NET Framework tertentu atau paket Azure Storage NuGet - yang perlu Anda lakukan adalah mengubah versi dari kontrol Browser API, dan konten akan menyesuaikan dengan sesuai:
Dibangun dengan ingat Open Source
Untuk membangun Browser API, kami menggunakan standar dan alat terbuka. Pada intinya, kami memanfaatkan DocFX - toolchain generasi dokumentasi terbuka, bersama dengan aplikasi mdoc Xamarin.
Semua dokumentasi referensi terkelola kami sekarang dibuat secara otomatis dari biner yang dikirim di NuGet atau merupakan bagian dari distribusi kerangka kerja utama, seperti .NET Framework atau .NET Core.
Infrastruktur integrasi berkelanjutan kami memungkinkan kami memiliki dokumentasi yang akurat untuk API terbaru yang sekarang dapat berpublis dalam beberapa jam sejak rilis, terbuka untuk kontribusi. Kami juga telah menstandarkan semua dokumentasi .NET API pada format ECMAXML, yang menciptakan representasi API yang konsisten dan komprehensif terlepas dari SDK yang didokumentasikan. Selain itu, Anda tidak perlu mengetahui seluk-beluk format file, karena Anda dapat berkontribusi konten di Markdown, yang disematkan dalam dokumen yang dibuat secara otomatis. Kontribusi komunitas untuk dokumentasi referensi akan diaktifkan dalam sebulan ke depan.
Fokus pada konten
Selain pengalaman baru, kami juga telah mengoptimalkan konten referensi agar lebih mudah ditemukan dan dibaca. Kami telah memperbarui daftar isi agar selalu berfokus pada namespace. Baik Anda menelusuri informasi tentang namespace, jenis, atau anggota, kami akan selalu menunjukkan hanya namespace induk dengan semua jenis turunannya & anggota yang dikelompokkan masing-masing:
Yang berarti bahwa halaman referensi berantakan dan menunjukkan kepada Anda informasi terpenting terlebih dahulu, seperti gambaran umum dan contoh - sekilas.
Anda juga akan melihat contoh yang relevan dengan Anda langsung dari awal, difilter ke bahasa pemrograman pilihan Anda - Anda tidak lagi harus menggulir ke bagian paling bawah halaman untuk menemukannya.
Didorong oleh umpan balik
Ini hanyalah awal dari kami mengubah pengalaman dokumentasi referensi. Kami ingin mendengar umpan balik Anda tentang bagaimana kami dapat membuat dokumentasi kami lebih menarik, berguna, dan membuat Anda dalam perjalanan secepat mungkin. Buka situs UserVoice kami dan beri tahu kami bagaimana kami dapat meningkatkan pengalaman Browser API kami. Anda juga selalu dapat menghubungi kami di Twitter, @docsmsft, untuk pembaruan cepat.