PHP Tabanlı Uygulamalar Manual

5 Cevap php

Tehcnical / API tip kılavuzları yazmak için herhangi bir iyi yapılmış web uygulamaları var mı? Ben bazı "başlarken" kılavuzları ve belki bazı referans içerik yazmak istiyorum bazı kod var.

PhpDocumentor tüm ince ve benim sınıf hiyerarşi belgelenmesi için iyidir, ama ben de biraz daha insan okunabilir ve doğrusal birlikte bir şeyler koymak istiyorum. Ben genel bir CMS cezası çalışmak herhalde, ya da sadece sıfırdan bir şey inşa. Akılda online kılavuzları yazı ile özel olarak dizayn edilmiştir şey varsa, ben daha fazla öğrenmek isterdim.

5 Cevap

DocBook kılavuzu yazmak için yollarından biri olacağını, ama bunun için herhangi bir CMS bilmiyorum. Ben PEAR çalışan payımız yaşadım ve şimdiye kadar ben hep / sayfaları düzenlemek yazmak için normal bir metin düzenleyicisi kullandım. Ben sıfırdan başlayarak harder olduğunu düşünün.

Eğer bir şey gerekiyorsa more, sezgisel, try dokuwiki. Oldukça küçük ve hafif, ve çalışıyor.

Ayrıca, belki (örneğin: inline {@example}) de o birine bakmak, phpdoc vb kod örnekleri gömmek için izin unutmayın.

Çoğu wiki benzeri hizmeti kendi belgelerine yazmak. Google kod bir tane var, ya da böyle MediaWiki veya Trac gibi, kendi yükleyebilirsiniz.

Sizin için işi yapmak olsaydı ben bilmiyorum, ama üzerinden online olarak PHP tüm kılavuzu www.php.net bir açık kaynak uygulaması.

Onun internals hakkında biliyorum, ama kullanıcı POV yeterince iyi görünüyor yok.

restructured text popüler bir seçimdir Python topluluk olduğunu.