Panduan membaca yang dilokalisasi
documentationTujuan, penggunaan, dan sumber
Menulis dan memelihara dokumentasi teknis. Dipicu dengan perintah "tulis dokumen untuk", "dokumentasikan ini", "buat README", "tulis runbook", "panduan onboarding", atau ketika pengguna membutuhkan bantuan dengan segala bentuk penulisan teknis — dokumentasi API, dokumentasi arsitektur, atau runbook operasional.
Sumber diambil:
- Repositori sumber
- anthropics/knowledge-work-plugins
- SKILL.md
engineering/skills/documentation/SKILL.md- Bintang Repositori
- 34,049
- Pembaruan terakhir repositori
- 2026-10-30
- Klasifikasi Kemampuan
- Dokumen
- Waktu pengumpulan terbaru
Lisensi: Apache-2.0
Cuplikan alur kerja adalah alat bantu baca, bukan instruksi yang dapat dieksekusi dari Codez. Tidak ada Skill pihak ketiga yang dijalankan untuk menghasilkan halaman ini.
Bagian yang menjelaskan tujuan dan alur kerja di bawah ini merupakan materi dari hulu, yang telah diorganisir dan diterjemahkan untuk dibaca. Bagian ini berbeda dari analisis editorial Codez yang diberi label secara terpisah.
Apa yang dilakukan oleh Skill ini?
Menulis dan memelihara dokumentasi teknis. Dipicu dengan perintah "tulis dokumen untuk", "dokumentasikan ini", "buat README", "tulis runbook", "panduan onboarding", atau ketika pengguna membutuhkan bantuan dengan segala bentuk penulisan teknis — dokumentasi API, dokumentasi arsitektur, atau runbook operasional.
Bagaimana alur kerja hulu bekerja
Dokumentasi Teknis
Tulis dokumentasi teknis yang jelas dan mudah dipelihara untuk berbagai audiens dan tujuan.
Jalur hulu · L6 ↗BACA SAYA
Apa ini dan mengapa ini ada Panduan singkat (<5menit hingga keberhasilan pertama)
Jalur hulu · L12 ↗Dokumentasi API
Referensi titik akhir denganrequest/responseContoh kode otentikasi dan kesalahan
Jalur hulu · L18 ↗Persyaratan dan pengaturan
Tidak ada bagian persyaratan singkat yang dipilih dari file ini. Ini tidak berarti Skill tersebut tidak memiliki dependensi. Periksa petunjuk pengaturan repositori dan file yang dirujuk.
Batasan dan pemeriksaan kualitas
Tidak ada bagian batasan terpisah yang dipilih dari file ini. Ini tidak berarti Keterampilan ini aman untuk setiap input atau lingkungan. Tinjau sumber lengkapnya dan validasi hasil Anda sendiri.
Mulailah dengan uji coba yang aman.
- Periksa host yang didukung dan petunjuk instalasi repositori. Simpan direktori Skill beserta skrip, aset, dan dokumentasi yang dirujuk di dalamnya secara bersamaan;SKILL.mdsendirian dapat menghilangkan dependensi.
- Berikan input sebenarnya, output yang diinginkan, dan kriteria penerimaan kepada agen. Sintaks pemanggilan dan alat yang tersedia bergantung pada host; situs ini tidak mengasumsikan perintah instalasi universal.
- Cobalah alur kerja sumber dalam proyek sementara atau pada salinannya. Tinjau operasi yang mengubah file, layanan jarak jauh, atau sumber daya yang dapat ditagih sebelum mengizinkannya.
- Validasi output terhadap pemeriksaan kualitas sumber dan persyaratan Anda sendiri. Pemicu yang berhasil atau jumlah bintang repositori yang tinggi tidak menjamin hasil yang benar.
Baca selengkapnya di sumber aslinya.
Keterampilan Terkait
Terjemahan dan ruang lingkup
Panduan membaca ini memilih bagian-bagian dari teks yang telah disematkan di bagian atas.SKILL.mdTerjemahan ini dibantu. Ini bukan manual lengkap atau klaim kompatibilitas yang telah diuji. Bacalah dokumen asli dan file referensinya sebelum digunakan.
Pendahuluan ini mengacu pada versi yang disematkan di bawah ini; aktivitas repositori saat ini dan waktu pengumpulan ditampilkan secara terpisah.
- Sumber yang disematkan
- Baca teks aslinya ↗
- Sumber diambil
- Komit sumber
2574e29377c7173d0cecffef29a6ecbd7f8ccb5d- Sumber SHA-256
1d469418f786a05be83d2a05f04d68788aeed584d13863a650f5ad73c6c4cf50