Teknik Yazılım Dökümanı Nasıl Hazırlanır ?

Forumda kod paylaşılırken dikkat edilmesi gerekenler. (Lütfen okuyunuz.)

Teknik Yazılım Dökümanı Nasıl Hazırlanır ?

kazim.karagul

Merhaba arkadaşlar,

Geliştirdiğiniz masaüstü veya web yazılımlarında, api modüllerde nasıl döküman hazırlıyorsunuz ? Bunun için bir yazılım, site veya bir aracınız var ı ? Dökümanların çoğunun teması birbirine benziyor. Bir zamanlar rastlantı sonucu döküman için kullanılabilecek örnek html temalara denk gelmiştim şimdi bulamadım. Bildiğiniz döküman temaları var mı ? veya hangi kelimelerle arayıp dana geniş çaplı bir sonuca ulaşabiliriz ?

Kısacası döküman hazırlamaya dair bilgilerinizi paylaşabilir misiniz?

ak

Merhaba,

phpdoc etiketleri düzenli yazılırsa kolay bir şekilde oluşturulabilir diye düşünüyorum.
https://github.com/mpociot/laravel-apidoc-generator
https://github.com/dingo/api , https://github.com/dingo/api/wiki/API-Blueprint-Documentation
https://www.phpdoc.org/
https://topluluk.ozguryazilim.com.tr/phpdocumentor-ile-phpdoc-olusturun/
http://savascanaltun.com.tr/phpdoc-kullanimi-ve-etiketler.html

İyi çalışmalar..

loc

dokumantasyonu api icin hazirladigim routes tanimlamalarina bakarak yapiyorum. Rotalarimi olustururken phpdoc ile detayli aciklamalar yapip rotalarimi grupluyorum. Parametrelerim icinde rotanin bagli oldugu metodun phpdoc kismindaki params etiketinde tanimlamis oldugum bilgilere gore hazirliyorum.

kazim.karagul

@ak
Linkler için teşekkür ederim.

@Ioc
Bu işlemler sonucunda bir not defterine mi word dosyasına mı yoksa html dosyasına mı yazıyorsunuz ? Ben hem ön hazırlık kısmını hem bitirdikten sonraki kısmını merak ediyorum. Nasıl bir çalışma yaptığınızı yazmışsınız. Bu işlemlerden sonraki adımlarınız nelerdir ?

loc

Guzel bir template hazirliyorum. Sonucta her modulun islemi farkli oldugu icin bu template icinde gruplandirip ona gore dokumante ediyorum.

evrend

Api için kullanılabilir: swagger.io , Döküman vs. çok hızlı oluşturabilirsiniz. Büyük firmaların api dökümanlarında sık sık görmeye başladım.

kazim.karagul

@Ioc merakla bekliyorum

@evrend Teşekkür ederim öneriniz için.

Laravel Türkiye Forumları, ücretsiz forum uygulaması Flarum ile yapılmıştır.