Ответы пользователя по тегу Документация
  • Как правильно писать документацию проекта?

    @abukirev
    C++/Qt developer/Tech Lead
    На мой взгляд для команды из 4-5 программистов не нужен технический писатель. Вы ведь не SDK или еще чего подобное разрабатываете, которое пойдет наружу сотням-тысячам пользователей...

    На сколько я понял речь идет о внутренней документации для разработчиков. И в этом случае подойдут простые и проверенные решения как:
    - Документирование исходного кода. Инструменты типа Doxygen вам в помощь
    - Документирование каких-то особенностей вне кода. Любые варианты wiki вам помогут. Например, MediaWiki
    - Документирование архитектурных решений. Можно использовать различные инструменты для UML проектирования, типа StarUML или Umbrello
    - Дополнительно можно задокументировать разные API и прочие штуки которые не попали в предыдущие части. Для этого вполне подойдет или wiki или те же google docs.

    Ну и конечно же не забудьте использовать систему контроля версий исходного кода и придерживаться принципа атомарности коммитов, тогда это тоже будет не плохим подспорьем.
    Ответ написан
  • Что нужно указать в сокращенной версии ТЗ (пользовательских требованиях) для того чтобы его понимали все стороны?

    @abukirev
    C++/Qt developer/Tech Lead
    Вот подумал, и написал образец краткого описания.

    Ну так добавьте к каждому из этих пунктов по 3-7 строчек описания и будет вам лист краткой версии. Если люди, которые будут это обсуждать, разбираются в предметной области и понимают чего хотят, то такого краткого описания будет более чем достаточно.
    Ответ написан