Нужна структура документации

Question

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

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

Редактировать: Специфический язык для самих документов не имеет особого значения. На данный момент мне просто нужны хорошие варианты для изучения.

Answer 1

Общепринятый метод документирует код с комментариями, а затем генерирует документацию из что. Для PHP есть PHPDoc например http://www.phpdoc.org/

Answer 2

В зависимости от языка выбора, есть много инструментов, которые могут генерировать документацию страниц из в-коды комментариев документации (например, Doxygen для C/C++, Javadoc для Java)

Убедитесь, что вы не только документы классов и методы, но также предоставляют примеры использования и нетривиальное объяснение того, что класс должен делать и как он вписывается в структуру.