Ручные приложения на основе PHP

Question

Существуют ли хорошо разработанные веб-приложения для написания технических руководств / инструкций по API? У меня есть код, для которого я хочу написать несколько руководств по началу работы и, возможно, некоторый справочный контент.

PHPDocumentor отлично подходит для документирования иерархии моего класса, но я также хочу собрать что-то более читабельное и линейное. Я полагаю, что обычная CMS будет работать нормально или просто создавать что-то с нуля. Но если есть что-то, что было разработано специально для написания онлайн-инструкций, я бы хотел узнать больше.

Answer 1

DocBook был бы одним из способов написания руководства, но я не знаю ни одной CMS для него. Моя часть работала над PEAR, и до сих пор я всегда использовал обычный текстовый редактор для написания / редактирования страниц. Я полагаю, начинать с нуля сложнее.

Если вам нужно что-то более интуитивное, попробуйте dokuwiki. Это довольно маленький и легкий, и это работает.

Также имейте в виду, что phpdoc позволяет встраивать примеры кода и т. Д., Поэтому, возможно, посмотрите и на этот пример (например: inline {@example}).

Answer 2

Большинство пишут свою документацию в вики-сервисе. У кода Google есть один, или вы можете установить свой собственный, такой как MediaWiki или Trac.

Answer 3

Я не знаю, подойдет ли вам эта работа, но все руководство по PHP, доступное онлайн через www.php.net, является приложением с открытым исходным кодом.

Не знаю о его внутренностях, но выглядит достаточно хорошо от пользователя POV.

Answer 4

Я нашел эти ссылки некоторое время назад....

http://www.winnershtriangle.com/w/Products.PHPDocumentationTool.asp

http://doc.php.net/php/dochowto/

наслаждаться...

Answer 5

реструктурированный текст является популярным выбором в сообществе Python.