İçeriğe geç
ai101.tools
gezesckapat
Claude+372Whisper+228LangChain+168Codex+223NotebookLM+276DALL-E 3+192DeepL+249n8n+208Topaz Video AI+153LlamaIndex+161
Documentation Writer (Diátaxis) logo
Skill

Documentation Writer (Diátaxis)

Teknik dokümanı öğretici, nasıl yapılır, başvuru ve açıklama olarak ayırır.

0
KaydetSiteye git ↗

Kurulum

gh skills install github/awesome-copilot documentation-writer
Ne zaman devreye girer

When product or developer documentation is written or an existing doc set is restructured.

Geliştirici
github/awesome-copilot contributors
Lisans
MIT

Dokümanların çoğu, tek sayfa aynı anda hem öğretmeye hem yönlendirmeye hem açıklamaya çalıştığı için okunmuyor. Burada Diátaxis çerçevesi uygulanıyor: sayfanın dört türden hangisi olduğu önce kararlaştırılıyor, sonra yalnız o türün dili ve yapısıyla yazılıyor. Öğretici sonu garantili bir ders, nasıl yapılır araziyi zaten bilen birine tarif, başvuru sayfası ise yorumsuz betimlemedir.

Yorumlar(0)

Yorum yapmak için giriş yap

Henüz yorum yok — ilk yorumu sen yaz.

Benzer skill'ler

Bu yorumu şikayet et

Neden şikayet ediyorsun?