Все сервисы Хабра

Сообщество IT-специалистов

Ответы на любые вопросы об IT

Профессиональное развитие в IT

Удаленная работа для IT-специалистов

Как организовать веб-студию на дому и сколько это может стоить
Войти на сайт
  • Все вопросы
  • Все теги
  • Пользователи

Хабр Q&A — вопросы и ответы для IT-специалистов

Получайте ответы на вопросы по любой теме из области IT от специалистов в этой теме.

Узнать больше
другие проекты хабра
  • Хабр
  • Карьера
  • Фриланс
Задать вопрос
eduardtibet

Эдуард Тибет

Technical Writer / Documentation Engineer
  • 42
    вклад
  • 2
    вопроса
  • 142
    ответа
  • 18%
    решений
Ответы
  • Информация
  • Ответы
  • Вопросы
  • Комментарии
  • Подписки
  • Нравится
  • Достижения
  • Какие есть инструменты для динамического формирования документации?

    eduardtibet
    Эдуард Тибет @eduardtibet
    Technical Writer / Documentation Engineer
    Добрый день!

    Ту задачу, которую вы описали, под силу docbook. Там есть специальный функционал, называемый Docbook profiling (как в один проход, так и в два прохода) (подробнее здесь: www.sagehill.net/docbookxsl/Profiling.html).

    Однако, внедрение docbook - неординарная задача, которая требует некоторых усилий и для _маленьких_ проектов невыгодна. Если же у вас проект, который предполагает наличие НЕСКОЛЬКИХ срезов (например, разные аудитории/заказчики/OS) и одновременно нескольких форматов вывода, то docbook однозначно. И все это идет из одного источника, в т.ч. (в особо сложных случаях) с помощью Apache Cocoon в автоматическом режиме по http get).

    Если интересуют подробности, спрашивайте - постараюсь ответить.
    Ответ написан более трёх лет назад
    Комментировать
    Нравится Комментировать
  • Как написать техническую документацию к проекту?

    eduardtibet
    Эдуард Тибет @eduardtibet
    Technical Writer / Documentation Engineer
    Добрый день!

    Вообще для такой цели (именно документация по коду, если я правильно понял вопрос) существуют специальные утилиты, которые позволяют выцеплять документацию/комментарии (написанную разработчиками прямо в коде). Вы смотрели в сторону doxygen (www.doxygen.org)?

    P.S. Непонятно только, зачем все это _хранить_ в pdf. PDF - это средство представления, а не формат хранения/обработки.
    Ответ написан более трёх лет назад
    Комментировать
    Нравится Комментировать
Оценили как «Нравится»
  • ← Предыдущие
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
Самые активные сегодня
  • tyllo
    tyllo
    • 7 ответов
    • 0 вопросов
  • sergey-gornostaev
    Сергей Горностаев
    • 7 ответов
    • 0 вопросов
  • neuotq
    Александр Талалаев
    • 7 ответов
    • 0 вопросов
  • MrDecoy
    Вадим
    • 6 ответов
    • 0 вопросов
  • SoreMix
    SoreMix
    • 6 ответов
    • 0 вопросов
  • enkryptor
    Виталий Сергеев
    • 6 ответов
    • 0 вопросов
  • © Habr
  • О сервисе
  • Обратная связь
  • Блог

Войдите на сайт

Чтобы задать вопрос и получить на него квалифицированный ответ.
Войти через центр авторизации