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

В чем писать документацию?

Тема в разделе "Прочее", создана пользователем Koc, 17 окт 2009.

  1. Koc

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

    С нами с:
    3 мар 2008
    Сообщения:
    2.253
    Симпатии:
    0
    Адрес:
    \Ukraine\Dnepropetrovsk
    Интересует в чем бы написать документацию. Что-то типа описание API, логики работы приложения.

    phpDoc не катит, так как будут диаграммы. UML... не знаю, будет много текста и я не знаю его.
     
  2. Hight

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

    С нами с:
    5 мар 2006
    Сообщения:
    7.153
    Симпатии:
    0
    Адрес:
    из злой параллельной вселенной
    Насколько помню в powerchm писал документацию. Завтра посмотрю.

    // Вылетело из головы название проги
     
  3. Simpliest

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

    С нами с:
    24 сен 2009
    Сообщения:
    4.511
    Симпатии:
    2
    Адрес:
    Донецк
    Диаграммы рисуй в Visio или Dia.
    И вставляй в документацию phpDoc.
     
  4. Elkaz

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

    С нами с:
    26 июн 2006
    Сообщения:
    3.373
    Симпатии:
    0
    Адрес:
    Баку, Азербайджан
    Обычный текстовый файл :)
     
  5. Koc

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

    С нами с:
    3 мар 2008
    Сообщения:
    2.253
    Симпатии:
    0
    Адрес:
    \Ukraine\Dnepropetrovsk
    еще можно что-то WIKI-подобное, встроенное в систему управления проектами (trac, redmine)
     
  6. AlexGousev

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

    С нами с:
    25 мар 2006
    Сообщения:
    1.505
    Симпатии:
    0
    Адрес:
    Москва
    phpDoc проходит по файлам и собирает информацию о классах/методах/функциях, а на выходе получается DocBook, с которым можно делать еще много всего. Один из существенных плюсов докбука — генерация документации во множество форматов.
     
  7. lexa

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

    С нами с:
    22 июл 2007
    Сообщения:
    1.746
    Симпатии:
    0
    Адрес:
    Санкт-Петербург
    Мне нравится (хотя, слово "нравится" немного не туда, да) ручёнками: html (базовые теги) + что-то а-ля ббкоды для упрощения некоторых вещей + небольшой движок, который всё это соеденяет и совокупляет. :)
     
  8. Koc

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

    С нами с:
    3 мар 2008
    Сообщения:
    2.253
    Симпатии:
    0
    Адрес:
    \Ukraine\Dnepropetrovsk
    а диаграммы наверно в SVG-формате лучше всего делать...
     
  9. Amian

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

    С нами с:
    15 мар 2007
    Сообщения:
    189
    Симпатии:
    0
    Зачем тебе диаграммы ? UML используется для моделирования инфосистемы, а не для документирования.
     
  10. sorteros

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

    С нами с:
    28 авг 2009
    Сообщения:
    54
    Симпатии:
    0
    Amian, такой же вопрос возник.
     
  11. Simpliest

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

    С нами с:
    24 сен 2009
    Сообщения:
    4.511
    Симпатии:
    2
    Адрес:
    Донецк
    Ну, например, диаграммы классов :)

    Впрочем, кто сказал что нельзя использовать UML для документирования системы? :)
     
  12. sorteros

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

    С нами с:
    28 авг 2009
    Сообщения:
    54
    Симпатии:
    0
    Согласно моему субъективному мнению, максимум можно описать иерархии. Да и то только в том случае, если система очень массивна и(или) интуитивно непонятна. Целесообразность применения UML весьма сомнительна. А всё остальное в рамках документации - в печь.
     
  13. Koc

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

    С нами с:
    3 мар 2008
    Сообщения:
    2.253
    Симпатии:
    0
    Адрес:
    \Ukraine\Dnepropetrovsk
    мне нужно нарисовать диаграммы, для того что б люди поняли как работает моя система и них не возникало вопросов что в какой последовательности происходит.
     
  14. Simpliest

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

    С нами с:
    24 сен 2009
    Сообщения:
    4.511
    Симпатии:
    2
    Адрес:
    Донецк
    Тогда в топку UML

    Пользуй Visio и другие презентационные утилиты.
     
  15. iliavlad

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

    С нами с:
    24 янв 2009
    Сообщения:
    1.689
    Симпатии:
    4
    если надо получить описание своих функций по комментариям, которые ты оставил, то конечно phpDoc или подобное. при регулярном обновлении удобная штука. при нерегулярном проще в коде посмотреть что да как.
    если я правильно понимаю что надо, то диаграммы последовательностей тебе в помощь. http://en.wikipedia.org/wiki/Sequence_diagram
    будешь ты их делать в визио или другой программе - неважно.
    вставлять текст плюс диаграммы лучше в какую-нибудь вики - и править удобно, и смотреть привычно.