Dokumentasi .NET API dipindahkan dari MSDN ke docs.microsoft.com

Posting ini ditulis oleh Den Delimarsky, Manajer Program di Divisi Cloud + AI.

Kami sangat senang mengumumkan migrasi lengkap semua dokumentasi .NET Framework di 11 lokal dari MSDN ke docs.microsoft.com. Untuk memahami volume dan skala migrasi ini, konten .NET Framework mewakili lebih dari 9 juta dokumen API atau 20% dari volume seluruh Pustaka MSDN.

Tujuannya adalah untuk memberikan pengalaman terpadu, modern, dan konsisten untuk menemukan dan menavigasi semua API .NET yang dikirim oleh Microsoft, termasuk dukungan mendalam untuk penerapan versi, penggunaan, dan menjalankan sampel kode API, dengan mudah mengaktifkan pembaruan API menggunakan otomatisasi, dan mendukung kontribusi komunitas.

docs.microsoft.com memungkinkan pengalaman ini untuk:

• .NET Framework (versi 1.1 - 4.7.2)
• .NET Core (versi 1.0 - 2.1)
• .NET Standard (versi 1.0 - 2.0)
• Dan semua paket .NET API, SDK, dan NuGet yang dikirim oleh Microsoft

Cari semua MICROSOFT .NET API di satu tempat dengan Browser .NET API

Apakah Anda pernah dalam situasi di mana Anda mencari API, tetapi Anda hanya tidak tahu harus mulai dari mana? Kami telah membangun indeks pencarian API khusus, memungkinkan Anda menemukan API yang diperlukan dengan cepat dalam hitungan detik, dengan filter produk dan versi - Browser .NET API.

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:

Organisasi yang ditingkatkan

Di daftar isi sebelah kiri, konten dikelompokkan menurut namespace layanan dan jenis entitas dalam namespace tersebut. Saat Anda memilih kelas, misalnya, Anda akan melihat bahwa kami mengelompokkan entitas berdasarkan jenisnya masing-masing: Properti, Bidang, Metode, dan Peristiwa.

Atau, Anda juga dapat mencari dengan bantuan Browser .NET API dan bahkan memfilter versi API tertentu, semuanya dari daftar isi, sehingga mudah untuk menemukan API yang tepat yang Anda cari.

Pelanggan juga telah memberi tahu kami bahwa ketika Anda berada dalam halaman referensi API, terkadang sulit untuk menemukan unduhan, penyiapan, dan dokumentasi bermanfaat lainnya untuk API. Seperti yang Anda lihat pada gambar di bawah ini, Azure .NET SDK menggabungkan artikel dan dokumentasi referensi, semuanya dalam satu daftar isi!

URL intuitif

Ketika kami awalnya meluncurkan docs.microsoft.com, salah satu tujuan kami adalah memiliki URL hierarkis yang jelas, konsisten, dan intuitif. Jika Anda ingat menggunakan MSDN, beberapa URL .NET disusun seperti ini:

https://msdn.microsoft.com/library/8kszeddc(v=vs.110).aspx

Ini membuatnya sangat sulit untuk memahami apa konten ini, hanya dengan melihatnya.

Tautan di atas sekarang menjadi ini:

https://docs.microsoft.com/dotnet/api/system.array.sort

Berikut adalah beberapa aturan URL dari Book of URL kami untuk memastikan URL yang konsisten dan intuitif untuk .NET:

Namaspace

Pola: https://docs.microsoft.com/{locale}/dotnet/api/{namespace}

Contoh: https://docs.microsoft.com/dotnet/api/system.collections.generic/

Kelas

Pola: https://docs.microsoft.com/{locale}/dotnet/api/{namespace}.{class}

Contoh: https://docs.microsoft.com/dotnet/api/system.flagsattribute

Metode

Pola: https://docs.microsoft.com/{locale}/dotnet/api/{namespace}.{class}.{method}

Contoh: https://docs.microsoft.com/dotnet/api/system.decimal.add

Contohnya terlebih dahulu

Satu hal yang konsisten yang kami dengar dari wawancara dengan pelanggan adalah pentingnya contoh kode berkualitas tinggi, singkat, dan fungsional untuk API. Dalam MSDN, contoh disertakan di akhir halaman, yang berarti dalam beberapa contoh Anda perlu menggulir ke bawah 20+ kali untuk melihat contoh pertama untuk jenis. Pada Dokumen, contohnya adalah yang pertama seperti yang ditunjukkan di bawah ini:

Seperti MSDN, Docs mendukung semua bahasa .NET termasuk C#, VB, F#, dan C++

Jalankan contoh secara interaktif di browser

Saat bekerja dengan kode, cara terbaik untuk belajar adalah benar-benar menulis kode - kami ingin memastikan bahwa Anda dapat melakukannya langsung dari browser. Setahun yang lalu, kami meluncurkan fitur Try .NET, dan sepanjang tahun kami telah mengintegrasikannya di sejumlah artikel. Ke depannya, kami akan terus mengintegrasikan fungsionalitas ini dalam lebih banyak dokumen API, memungkinkan Anda untuk bereksperimen tanpa meninggalkan halaman.

Didukung oleh alat pembuatan otomatis standar

Semua dokumentasi API tentang docs.microsoft.com dibuat secara otomatis, memungkinkan kami untuk dengan mudah mendokumentasikan seluruh permukaan API, dan secara dramatis meningkatkan waktu dan frekuensi pembaruan dari minggu ke menit. Ini memastikan bahwa Anda mendapatkan dokumentasi API berkualitas untuk semua API .NET.

Untuk melakukan ini, kami bermitra dengan tim teknik Xamarin untuk mengembangkan dan menggunakan mdoc untuk menghasilkan semua dokumentasi Referensi .NET.

Tautan MSDN - mengalihkan ke docs.microsoft.com

Saat kami memulai migrasi, kami ingin memastikan bahwa tidak ada tautan yang rusak - semua tautan MSDN yang mungkin diintegrasikan dalam produk, posting blog, dan situs lain harus berfungsi dengan baik dan mengarahkan pengguna ke lokasi baru, dengan bantuan pengalihan standar 301.

Siap untuk kontribusi komunitas

Semua konten yang dimigrasikan sekarang sumber terbuka, di repositori dotnet/dotnet-api-docs di GitHub. Tetapi Anda tidak perlu mencari file untuk membuat kontribusi Anda - cukup buka salah satu halaman .NET API dan klik Edit, dan Anda akan dibawa langsung ke file yang ingin Anda buat perubahannya.

Kami ingin umpan balik Anda

Kami harap Anda menikmati format konten baru - silakan kirimi kami umpan balik Anda di GitHub atau Twitter.