За последние 24 часа нас посетили 16638 программистов и 1681 робот. Сейчас ищут 864 программиста ...

Документирование ПО

Тема в разделе "Прочее", создана пользователем Hight, 12 янв 2009.

  1. Hight

    Hight Старожил
    Команда форума Модератор

    С нами с:
    5 мар 2006
    Сообщения:
    7.153
    Симпатии:
    0
    Адрес:
    из злой параллельной вселенной
    Есть программный продукт. Нужно написать красивую документацию. Кто в чём пишет?

    Что требуется - экспорт в html, chm и т.д. Дока на вид php_manual`а вполне сойдёт.

    // MS Word не предлагать.
     
  2. Вообще документация — понятие растяжемое.
    Техническую документацию (АПИ) я бы делал phpdocumentor
    а польвательскую - в пдф, в ворде..
     
  3. Hight

    Hight Старожил
    Команда форума Модератор

    С нами с:
    5 мар 2006
    Сообщения:
    7.153
    Симпатии:
    0
    Адрес:
    из злой параллельной вселенной
    Это понятно, это давно уже делаю.
    Вот пользовательскую и надо делать. Мол на какую кнопочку нажимать и зачем и т.д.

    В ворде крыша едет это делать. Надо что-нибудь попроще.

    Структура документации проста:
    1. Оглавление
    2. Описание разделов

    Нужен какой-то визивиг, чтобы в нём это быстренько делалось, сделал оглавление ссылками, описал разделы и нажал сохранить в chm или pdf. Вот это было бы то, что нужно.
     
  4. Psih

    Psih Активный пользователь
    Команда форума Модератор

    С нами с:
    28 дек 2006
    Сообщения:
    2.678
    Симпатии:
    6
    Адрес:
    Рига, Латвия
    А разве phpDocumentator не даёт возможности делать так же просто страницы с текстом, ведь написана же как-то та часть мануала, где не function reference.
     
  5. AlexGousev

    AlexGousev Активный пользователь

    С нами с:
    25 мар 2006
    Сообщения:
    1.505
    Симпатии:
    0
    Адрес:
    Москва
    Кстати, phpDocumentor, вроде, генерит тот же DocBook, который можно во всякие форматы перегонять. Но визивига для DocBook я для себя так и не подобрал - ручками пишу :)
     
  6. AlexGousev

    AlexGousev Активный пользователь

    С нами с:
    25 мар 2006
    Сообщения:
    1.505
    Симпатии:
    0
    Адрес:
    Москва
    Оно в докбуке сделано, phpdoc - это для PHP, а не для С :) Или я что-то пропустил?
     
  7. Sergey89

    Sergey89 Активный пользователь

    С нами с:
    4 янв 2007
    Сообщения:
    4.796
    Симпатии:
    0