Memperkenalkan .NET Core Docs
Postingan ini ditulis oleh Jeff Sandquist, General Manager di Divisi Cloud + Enterprise.
Hari ini kami merilis pratinjau Dokumentasi .NET di docs.microsoft.com. Untuk mempelajari selengkapnya tentang peningkatan pengalaman dokumentasi baru docs.microsoft.com penawaran, kunjungi posting blog docs.microsoft.com pengenalan. Selain memiliki semua fitur kolaboratif, konten sumber terbuka, dan URL ramah yang tersedia di platform docs.microsoft.com, kami telah memperkenalkan beberapa fitur baru khusus untuk pengembang .NET. Posting ini akan menyoroti fitur-fitur baru ini dan meringkas rencana kami untuk masa depan.
Sorotan dari Pengalaman Dokumentasi .NET
Untuk menyertai rilis RTM yang menarik dari .NET Core, kami menempatkannya di depan dan di tengah di halaman beranda Dokumentasi .NET. Untuk melengkapi rilis .NET Core RTM dengan semua yang Anda perlukan untuk memulai dengan cepat, kami telah menempatkan tautan ke artikel dan pengalaman referensi baru di bagian atas daftar.
Ekosistem .NET di Ujung Jari Anda
Anda akan melihat tautan untuk mengunduh pustaka .NET Core baru, ASP.NET, Kerangka Kerja Entitas, Azure, menggunakan Xamarin untuk membangun aplikasi iOS menggunakan .NET, dan membangun aplikasi Universal Windows Platform (UWP) menggunakan .NET. Kami belum memindahkan semua konten .NET ke docs.microsoft.com belum, tetapi halaman beranda Dokumentasi .NET akan menjadi titik awal Anda untuk sampai ke semua dokumentasi .NET.
Artikel
Penulis dan insinyur kami, serta beberapa anggota komunitas khusus, telah bekerja tanpa lelah membuat artikel baru terkait .NET Core yang akan Anda temukan di bagian Dokumentasi .NET . Di sini Anda akan menemukan berbagai artikel seperti:
Ini dan banyak topik lainnya semuanya disajikan dalam tema docs.microsoft.com, dengan daftar isi yang bersih di setiap halaman, serta perkiraan waktu untuk membaca setiap artikel dan informasi kontributor untuk setiap artikel.
Semua artikel .NET adalah sumber terbuka dan tersedia di GitHub di repositori dokumen tim .NET. Jika Anda menemukan masalah dalam dokumentasi atau ingin meningkatkannya, melakukannya sem mudahnya dengan mengklik tombol edit di navigasi kanan setiap artikel.
Mengedit artikel semederhana mengklik tombol edit pada salah satu file Markdown di repositori, menambahkan konten Anda, dan mengirimkan permintaan pull. Setelah satu tim kami meninjau dan menerima permintaan pull Anda, kontribusi Anda akan ditayangkan di situs dalam hitungan menit.
Referensi API
Selain konten hebat yang ditulis oleh penulis, insinyur, dan anggota komunitas yang bersemangat, kami telah melakukan peningkatan signifikan pada pengalaman referensi. Pengalaman referensi telah sepenuhnya dirancang ulang dalam rilis pratinjau ini, meminjam prinsip desain yang sama dengan yang kami gunakan dalam artikel docs.microsoft.com.
Seperti artikel tersebut, halaman referensi baru responsif, dirancang dengan prinsip web modern, dan akan terlihat lebih baik di perangkat seluler.
Kami telah menambahkan Pencarian Tipe ke semua halaman Namespace. Ini memungkinkan Anda untuk dengan mudah mencari berdasarkan nama jenis untuk semua jenis .NET. Dengan setiap keypress, kami memfilter daftar jenis yang ditampilkan di navigasi kiri. Fitur baru yang menarik dari area referensi ini disertakan dalam kerangka kerja baru kami untuk menghasilkan dokumentasi referensi .NET yang dikenal sebagai DocFX, proyek sumber terbuka di GitHub).
Saat Anda mengeklik jenis individual di navigasi kiri untuk namespace layanan apa pun, Anda akan langsung melompat ke bagian pengenalan halaman namespace ke jenis tersebut. Dengan mengklik nama jenis di area utama konten referensi, Anda akan melihat halaman detail kelas, yang berisi rantai warisan kelas, deklarasi, dan detail tentang properti kelas dan anggota metode.
Untuk setiap anggota metode, Anda akan melihat detail tentang parameter dan ringkasan metode.
Prinsip Informasi dan Teknik
Selain pengembangan dan peningkatan berkelanjutan pada alat pembuatan dokumen DocFX, kami telah melakukan peningkatan signifikan pada prinsip-prinsip rekayasa dan dokumentasi yang akan Anda lihat terbukti dalam pengalaman Dokumentasi .NET baru.
Otomatisasi yang Lebih Baik
Ketika permintaan pull diterima dari kontributor potensial, kami memvalidasi bahwa kontributor telah mengikuti proses sederhana penandatanganan Perjanjian Lisensi Kontributor kami (proses ini sepenuhnya elektronik dan membutuhkan waktu beberapa menit untuk diselesaikan). Selama kontribusi mematuhi Pedoman Kontribusi, perubahan kecil akan muncul secara langsung di situs beberapa menit setelah permintaan pull diterima.
URL yang lebih baik
Salah satu prinsip penting dari keseluruhan pengalaman docs.microsoft.com adalah URL yang lebih baik untuk meningkatkan pengindeksan pencarian dan "menebak." Kami telah mempertahankan prinsip ini dalam Dokumentasi .NET. Baik artikel maupun dokumentasi referensi memiliki URL yang lebih bersih. Ambil contoh URL MSDN klasik untuk namespace layanan Sistem:
Dalam dokumentasi referensi baru, URL lebih logis, dapat dibaca manusia, dan yang paling penting, lebih dapat ditemukan.
Lebih Agile dan Buka Penulisan
Konten tidak hanya sumber terbuka, dan kami tidak hanya menerima kontribusi komunitas. Selain itu, semua konten di docs.microsoft.com (termasuk Dokumentasi .NET) semuanya tersedia di bawah lisensi Creative Commons. Anda dapat membacanya, menyalinnya, mereferensikannya, dan menggunakan kembali bagian-bagiannya (bahkan untuk penggunaan komersial). Penulis dan insinyur telah bekerja dengan anggota komunitas secara aktif selama berbulan-bulan dalam sistem baru. Ini adalah transisi yang menarik dan menarik, dan kami memiliki lebih banyak hal untuk datang di masa depan.
Rencana Masa Depan
Bagian docs.microsoft.com ini, seperti halnya situs lainnya, masih dalam pratinjau, jadi kami mendorong umpan balik dan komentar yang konstruktif. Kirimkan ide fitur Anda ke UserVoice.
Dalam beberapa minggu mendatang, kami akan menerbitkan komentar XML yang digunakan untuk menghasilkan dokumentasi referensi langsung ke dalam kode sumber .NET. Ini akan memungkinkan siapa pun untuk dengan mudah mengklik perbarui dokumentasi referensi .NET Framework.
Kami juga akan terus mengubah desain dan tata letak referensi, serta kemampuan yang disebutkan di atas untuk mengedit konten referensi itu sendiri.
Kami sangat antusias untuk membawa Anda area Dokumentasi .NET baru di docs.microsoft.com, dan kami berharap dapat membuat pengalaman Anda lebih baik di masa depan!